Class: LWS::Presence::Location::Map

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::Presence::Location::Map

Defined in:

lib/lws/apps/presence.rb

Overview

Note:

This class is only used within the context of the LWS::Presence::Location class.

The location map class

Defined Under Namespace

Classes: Position

Instance Attribute Summary

• #image_storage_id ⇒ String^?

  The storage ID of the image of the map.

• #image_url ⇒ String^?

  The URL of the image of the map.

• #location ⇒ Location

  The location the map belongs to.

• #location_id ⇒ Integer

  The ID of the location the map belongs to.

• #name ⇒ String^?

  The name of the map.

• #picture_url ⇒ String^? deprecated Deprecated.

  Unauthenticated retrieval of the picture will not longer be supported in upcoming releases of LWS. Use #image_url instead!

• #position ⇒ Integer

  The position (index) of the map, if multiple are present.

• #position_ids ⇒ Array<Integer>

  The IDs of the positions linked to this map.

• #positions ⇒ Array<Location::Map::Position>

  The positions linked to this map.

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#deep_dup, #dig, #reload, #rollback, #save

Instance Attribute Details

#image_storage_id ⇒ String^?

Returns the storage ID of the image of the map.

Returns:

• (String, nil) —

  the storage ID of the image of the map

# File 'lib/lws/apps/presence.rb', line 367

attribute :image_storage_id

#image_url ⇒ String^?

Note:

To be able retrieve this, the token needs to be passed via X-Token in the HTTP request headers!

Returns the URL of the image of the map.

Returns:

• (String, nil) —

  the URL of the image of the map

# File 'lib/lws/apps/presence.rb', line 374

attribute :image_url

#location ⇒ Location

Returns the location the map belongs to.

Returns:

• (Location) —

  the location the map belongs to

# File 'lib/lws/apps/presence.rb', line 378

belongs_to :location

#location_id ⇒ Integer

Returns the ID of the location the map belongs to.

Returns:

• (Integer) —

  the ID of the location the map belongs to

# File 'lib/lws/apps/presence.rb', line 382

attribute :location_id

#name ⇒ String^?

Returns the name of the map.

Returns:

• (String, nil) —

  the name of the map

# File 'lib/lws/apps/presence.rb', line 386

attribute :name

#picture_url ⇒ String^?

Deprecated.

Unauthenticated retrieval of the picture will not longer be supported in upcoming releases of LWS. Use #image_url instead!

Returns the URL of the picture of the map.

Returns:

• (String, nil) —

  the URL of the picture of the map

# File 'lib/lws/apps/presence.rb', line 393

attribute :picture_url

#position ⇒ Integer

Returns the position (index) of the map, if multiple are present.

Returns:

• (Integer) —

  the position (index) of the map, if multiple are present

# File 'lib/lws/apps/presence.rb', line 398

attribute :position

#position_ids ⇒ Array<Integer>

Returns the IDs of the positions linked to this map.

Returns:

• (Array<Integer>) —

  the IDs of the positions linked to this map

# File 'lib/lws/apps/presence.rb', line 402

attribute :position_ids

#positions ⇒ Array<Location::Map::Position>

Returns the positions linked to this map.

Returns:

• (Array<Location::Map::Position>) —

  the positions linked to this map

# File 'lib/lws/apps/presence.rb', line 407

has_many :positions