Declares the list of all constants (enumerations) utilized by various API components. More...
#include <GlympseConstants.h>
Static Public Member Functions | |
Ticket visibility | |
| static GString | TICKET_VISIBILITY_LOCATION_VISIBLE () |
| TICKET_VISIBILITY_KEY_LOCATION() value indicating visible location. | |
| static GString | TICKET_VISIBILITY_LOCATION_HIDDEN () |
| TICKET_VISIBILITY_KEY_LOCATION() value indicating hidden location. | |
| static GString | TICKET_VISIBILITY_KEY_LOCATION () |
| Key to retrieve the location visibility from ITicket::getVisibility. | |
| static GString | TICKET_VISIBILITY_KEY_CONTEXT () |
| Key to retrieve the visibility context from ITicket::getVisibility. | |
Linked Accounts | |
| static GString | LINKED_ACCOUNT_TYPE_FACEBOOK () |
| Facebook. | |
| static GString | LINKED_ACCOUNT_TYPE_TWITTER () |
| Twitter. | |
| static GString | LINKED_ACCOUNT_TYPE_EVERNOTE () |
| Evernote. | |
| static GString | LINKED_ACCOUNT_TYPE_GOOGLE () |
| Google+. | |
| static GString | LINKED_ACCOUNT_TYPE_PAIRING () |
| Pairing Code. | |
| static GString | LINKED_ACCOUNT_TYPE_PHONE () |
| Phone Number. | |
| static GString | LINKED_ACCOUNT_TYPE_EMAIL () |
| Email Address. | |
Linked Account Properties | |
| static GString | LINKED_ACCOUNT_PROPERTY_INVITE_CLIENT_SEND () |
| This property controls whether invites of the associated linked account type are sent by the sever, or whether the host application perfers to send them itself. More... | |
Card Object types | |
Constants defining what type of object a card object is. | |
| static GString | CARD_OBJECT_TYPE_POI () |
| static GString | CARD_OBJECT_TYPE_INVITE () |
| static GString | CARD_OBJECT_TYPE_UNKNOWN () |
Card IDs | |
Supported card ids, to be used when creating a card with GlympseFactory::createCard(...) | |
| static GString | CARD_ID_PRIVATE_GROUP () |
| Private group card ID. | |
Static Public Attributes | |
SMS Modes | |
SMS mode defines party responsible for SMS delivery. | |
| static const int32 | SMS_SEND_MODE_DEFAULT = 1 |
| The default SMS send mode allows the Glympse API to query the device and determine if an SMS invite should be sent locally from the device's SMS number or remotely from the Glympse server SMS provider. More... | |
| static const int32 | SMS_SEND_MODE_DEVICE = 2 |
| The device SMS send mode forces the Glympse API to always send SMS invites from the device's SMS number. | |
| static const int32 | SMS_SEND_MODE_SERVER = 3 |
| The server SMS send mode forces the Glympse API to always send SMS invites through the Glympse server SMS provider. | |
Device SMS Capabilities | |
Constants for identifying device SMS capabilities. | |
| static const int32 | SMS_SEND_AUTO = 1 |
| The device is capable of sending SMS messages programmatically. | |
| static const int32 | SMS_SEND_MANUAL = 2 |
| The device is capable of sending SMS messages, but user confirmation is required. | |
| static const int32 | SMS_SEND_NOT_SUPPORTED = 3 |
| The device is not capable of sending SMS messages. | |
ETA Modes | |
Supported ETA modes. | |
| static const int32 | ETA_MODE_EXTERNAL = 1 |
| In this mode ETA information should be provided externally. More... | |
| static const int32 | ETA_MODE_INTERNAL = 2 |
| Glympse API will attempt to calclulate ETA in this mode. | |
Invite Decoding Modes | |
Various flags that can be applied when decoding invites.
| |
| static const int32 | INVITE_MODE_DEFAULT = 0x00000000 |
| Default mode for invites decoding. More... | |
| static const int32 | INVITE_MODE_PROMPT_BEFORE_VIEWING = 0x00000001 |
| Enables viewing confirmation for ticket invites. More... | |
| static const int32 | INVITE_MODE_ACTIVATE_USER = 0x00000002 |
| Newly added standalone user will automatically be activated, if this mode is specified. More... | |
User Tracking Modes | |
User tracking mode defines the way platform deals with multiple concurrent incoming tickets received from a user. | |
| static const int32 | USER_TRACKING_MODE_ACTIVE = 0x00000001 |
| When running in this mode, platform tracks and provides host application with updates regarding the only ticket for a given user (the most recently received one). More... | |
| static const int32 | USER_TRACKING_MODE_ALL = 0x00000002 |
| Platform pulls updates for all active tickets received from a given user, when running in this mode. More... | |
Ticket States | |
Supported ticket states. | |
| static const int32 | TICKET_STATE_NONE = 0x00000001 |
| static const int32 | TICKET_STATE_ADDING = 0x00000002 |
| static const int32 | TICKET_STATE_INVALID = 0x00000004 |
| static const int32 | TICKET_STATE_ACTIVE = 0x00000010 |
| static const int32 | TICKET_STATE_EXPIRING = 0x00000020 |
| static const int32 | TICKET_STATE_EXPIRED = 0x00000040 |
| static const int32 | TICKET_STATE_DELETING = 0x00000080 |
| static const int32 | TICKET_STATE_DELETED = 0x00000100 |
| static const int32 | TICKET_STATE_FAILED_TO_CREATE = 0x00000200 |
| static const int32 | TICKET_STATE_CANCELLED = 0x00000400 |
| static const int32 | TICKET_STATE_DECODING |
| static const int32 | TICKET_STATE_ACTIVATING |
Invite Aspects | |
Glympse invite code (6 or 8 character string separated by a dash) always points to an object in Glympse universe (e.g. ticket or request to share location). Invite aspect identifies type of that object. | |
| static const int32 | INVITE_ASPECT_UNKNOWN = 0 |
| Invite of unknown aspect. More... | |
| static const int32 | INVITE_ASPECT_TICKET = 1 |
| Identifies invite pointing to ticket object. | |
| static const int32 | INVITE_ASPECT_REQUEST = 2 |
| Invite of this type represents a request to share location. | |
| static const int32 | INVITE_ASPECT_CARD = 3 |
| Invite of this type represents an invite to join a card. | |
Invite Types | |
Supported invite delivery mechanisms. | |
| static const int32 | INVITE_TYPE_UNKNOWN = 0 |
| static const int32 | INVITE_TYPE_ACCOUNT = 1 |
| static const int32 | INVITE_TYPE_EMAIL = 2 |
| static const int32 | INVITE_TYPE_SMS = 3 |
| static const int32 | INVITE_TYPE_TWITTER = 4 |
| static const int32 | INVITE_TYPE_FACEBOOK = 5 |
| static const int32 | INVITE_TYPE_LINK = 6 |
| static const int32 | INVITE_TYPE_GROUP = 7 |
| static const int32 | INVITE_TYPE_SHARE = 8 |
| static const int32 | INVITE_TYPE_CLIPBOARD = 9 |
| static const int32 | INVITE_TYPE_EVERNOTE = 10 |
| static const int32 | INVITE_TYPE_APP = 11 |
Invite States | |
Supported invite states. | |
| static const int32 | INVITE_STATE_NONE = 0 |
| static const int32 | INVITE_STATE_SERVERSENDING = 1 |
| static const int32 | INVITE_STATE_CLIENTSENDING = 2 |
| static const int32 | INVITE_STATE_NEEDTOSEND = 3 |
| static const int32 | INVITE_STATE_SUCCEEDED = 4 |
| static const int32 | INVITE_STATE_DELETING = 5 |
| static const int32 | INVITE_STATE_DELETED = 6 |
| static const int32 | INVITE_STATE_FAILED_TO_CREATE = 7 |
| static const int32 | INVITE_STATE_FAILED_TO_SEND = 8 |
| static const int32 | INVITE_STATE_FAILED_TO_DELETE = 9 |
Image States | |
Supported image states. | |
| static const int32 | IMAGE_STATE_NONE = 0 |
| static const int32 | IMAGE_STATE_LOADING = 1 |
| static const int32 | IMAGE_STATE_LOADED = 2 |
| static const int32 | IMAGE_STATE_FAILED = 3 |
Group States | |
Supported group states. | |
| static const int32 | GROUP_STATE_NONE = 0 |
| static const int32 | GROUP_STATE_INVALID = 1 |
| static const int32 | GROUP_STATE_ADDING = 2 |
| static const int32 | GROUP_STATE_PENDING = 3 |
| Intermediate group state, in which group finds itself once being decoded but not yet accepted by the user. | |
| static const int32 | GROUP_STATE_ACTIVE = 4 |
| static const int32 | GROUP_STATE_LEAVING = 5 |
| static const int32 | GROUP_STATE_LEFT = 6 |
| static const int32 | GROUP_STATE_FAILED_TO_CREATE = 7 |
| static const int32 | GROUP_STATE_FAILED_TO_JOIN = 8 |
| static const int32 | GROUP_STATE_FAILED_TO_LEAVE = 9 |
XoA (Expire on Arrival) Modes | |
Supported XoA modes. | |
| static const int32 | EXPIRE_ON_ARRIVAL_NONE = 0 |
| Automatic expiration logic is totally turned off in this mode. | |
| static const int32 | EXPIRE_ON_ARRIVAL_NOTIFY = 1 |
| Ticket subscribers are notified with GE::TICKET_ARRIVED event upon arrival to the destination. | |
| static const int32 | EXPIRE_ON_ARRIVAL_AUTO = 2 |
| Ticket is automatically expired upon arrival. More... | |
Group Name Verification Options | |
Values returned by IGroupManager::validateGroupName(). | |
| static const int32 | GROUP_NAME_CORRECT = 0 |
| Specified group name conforms to group name requirements. | |
| static const int32 | GROUP_NAME_TOO_SHORT = 1 |
| Specified group name is too short. | |
| static const int32 | GROUP_NAME_INVALID_CHARACTER = 2 |
| Specified group name contains invalid character. | |
| static const int32 | GROUP_NAME_JUST_DIGITS = 3 |
| Group name cannot consist of just numbers. | |
Miscellaneous Defaults | |
Default and no change constants. | |
| static const int32 | DURATION_NO_CHANGE = -1 |
| This constant can be used with the ITicket::modify method to specify that the duration should not be changed when modifying a ticket. | |
| static const int64 | HISTORY_LOOKBACK_DEFAULT = -1 |
| The value indicates that client platform falls back to default lookback interval specified on server side. More... | |
Context Constants | |
Constants defining the range of supported context keys. | |
| static const int64 | CONTEXT_KEY_MIN = 0x0L |
| Minimum value of context key. | |
| static const int64 | CONTEXT_KEY_MAX = 0xffffffffffffL |
| Maximum value of specific key. | |
Ticket Fields | |
The list of fields generally available under ticket object. | |
| static const int32 | TICKET_FIELD_INVITES = 0x00000001 |
| Refers to the list of invites. | |
| static const int32 | TICKET_FIELD_DURATION = 0x00000002 |
| Refers to ticket duration. | |
| static const int32 | TICKET_FIELD_MESSAGE = 0x00000004 |
| Refers to ticket message. | |
| static const int32 | TICKET_FIELD_DESTINATION = 0x00000008 |
| Refers to ticket destination. | |
External Handoff Actions | |
Actions commonly supported by handoff providers. | |
| static const int32 | HANDOFF_ACTION_SEND = 0x00000001 |
| Initiates sending a Glympse from a browser. | |
Travel Modes | |
Supported travel modes. | |
| static const int32 | TRAVEL_MODE_DEFAULT = 0 |
| Default travel mode. | |
| static const int32 | TRAVEL_MODE_DRIVE = 1 |
| Driving mode. | |
| static const int32 | TRAVEL_MODE_CYCLE = 2 |
| Cycling mode. | |
| static const int32 | TRAVEL_MODE_WALK = 3 |
| Walking mode. | |
| static const int32 | TRAVEL_MODE_AIRLINE = 4 |
| Flying mode. | |
| static const int32 | TRAVEL_MODE_TRANSIT = 5 |
| Transit mode. | |
Eta/Route Query Modes | |
Supported modes for querying eta and route. | |
| static const int32 | ETA_QUERY_MODE_ALWAYS = 0 |
| Always query eta/route (when enabled). | |
| static const int32 | ETA_QUERY_MODE_WATCHED = 1 |
| Only query eta/route when watched by someone, including self (i.e. More... | |
Linked Account States | |
All possible states for linked account objects. | |
| static const int32 | LINKED_ACCOUNT_STATE_NONE = 0 |
| Unknown. | |
| static const int32 | LINKED_ACCOUNT_STATE_LINKING = 1 |
| Linking in progress. | |
| static const int32 | LINKED_ACCOUNT_STATE_LINKED = 2 |
| Linked. | |
| static const int32 | LINKED_ACCOUNT_STATE_FAILED_TO_LINK = 3 |
| Failed to link. | |
| static const int32 | LINKED_ACCOUNT_STATE_UNLINKING = 4 |
| Unlinking in progress. | |
| static const int32 | LINKED_ACCOUNT_STATE_UNLINKED = 5 |
| Unlinked. | |
| static const int32 | LINKED_ACCOUNT_STATE_FAILED_TO_UNLINK = 6 |
| Failed to unlink. | |
| static const int32 | LINKED_ACCOUNT_STATE_REFRESHING = 7 |
| Refreshing in progress. | |
Linked Account Status | |
All possible status codes for linked account objects. | |
| static const int32 | LINKED_ACCOUNT_STATUS_NONE = 0 |
| Unknown. | |
| static const int32 | LINKED_ACCOUNT_STATUS_OK = 1 |
| Account status is good. | |
| static const int32 | LINKED_ACCOUNT_STATUS_REFRESH_NEEDED = 2 |
| Account metadata needs to be refreshed. | |
Linked Account Login Authorization | |
All possible states for linked account federated login permission. | |
| static const int32 | LINKED_ACCOUNT_LOGIN_NONE = 0 |
| Unknown. | |
| static const int32 | LINKED_ACCOUNT_LOGIN_ENABLED = 1 |
| Login enabled. | |
| static const int32 | LINKED_ACCOUNT_LOGIN_DISABLED = 2 |
| Login disabled. | |
Server error types. | |
Classes of errors that may be reported by the server. | |
| static const int32 | SERVER_ERROR_UNKNOWN = 1 |
| Generic or unknown error. | |
| static const int32 | SERVER_ERROR_FORMAT = 2 |
| The format of the request is invalid. | |
| static const int32 | SERVER_ERROR_ACCESS_DENIED = 3 |
| The request was denied due to access rights. | |
| static const int32 | SERVER_ERROR_LINK_FAILED = 4 |
| The request failed because third-party account validation failed. | |
| static const int32 | SERVER_ERROR_LINK_MISMATCH = 5 |
| The request failed because the third-party account specified is not the one linked to the user account. | |
| static const int32 | SERVER_ERROR_EXISTING_LINK = 6 |
| The request failed because the third-party account is already linked with a different user account. | |
| static const int32 | SERVER_ERROR_NOT_LINKED = 7 |
| The request failed because no third-party account of the specified type is linked. | |
| static const int32 | SERVER_ERROR_INVALID_TOKEN = 8 |
| The request failed because a required token is invalid or expired. | |
| static const int32 | SERVER_ERROR_DISABLED = 9 |
| The request failed because server disabled current platform installation. More... | |
Expiration Mode | |
Ticket expiration mode defines platform behavior with regards to ticket expiration. Depending on currently applied mode the platform requires server confirmation in order to alter local state (switch to 'not sharing' state from 'sharing') or is capable of performing the switch on its own. | |
| static const int32 | EXPIRATION_MODE_SYNCHRONIZED = 0 |
| All properties taken into account has to be synchronized with server, when running in this mode. | |
| static const int32 | EXPIRATION_MODE_DETACHED = 1 |
| Platform relies on local ticket state as well in order to make some decisions. | |
Track Sources | |
Track source specifies where track information is coming from. | |
| static const int32 | TRACK_SOURCE_UNKNOWN = 0 |
| The origin on track data is unknown. | |
| static const int32 | TRACK_SOURCE_GOOGLE_DIRECTIONS = 1 |
| Track data is provided by Google Directions API. | |
| static const int32 | TRACK_SOURCE_INFLIGHT = 2 |
| Track information is retrieved from a flight tracking service. | |
| static const int32 | TRACK_SOURCE_HERE_DIRECTIONS = 3 |
| Track data is provided by HERE Directions API. | |
| static const int32 | TRACK_SOURCE_GLYMPSE_DIRECTIONS = 4 |
| Track data is provided by Glympse Directions API. | |
Directions state. | |
State of Directions object. | |
| static const int32 | DIRECTIONS_STATE_UNKNOWN = 0 |
| The directions state is unknown. More... | |
| static const int32 | DIRECTIONS_STATE_FETCHING = 1 |
| The directions state is fetching. More... | |
| static const int32 | DIRECTIONS_STATE_SUCCESS = 2 |
| The directions state is succeeded. More... | |
| static const int32 | DIRECTIONS_STATE_FAILED = 3 |
| The directions state is failed. More... | |
Trigger Types | |
Trigger types based on criteria used to fire associated action. | |
| static const int32 | TRIGGER_TYPE_GEO = 1 |
| Trigger that is fired when user leaves specified geofence. | |
| static const int32 | TRIGGER_TYPE_CHRONO = 2 |
| Trigger that is fired at a specific time. | |
| static const int32 | TRIGGER_TYPE_ETA = 3 |
| Trigger that is fired based on a give ticket's ETA. | |
| static const int32 | TRIGGER_TYPE_ARRIVAL = 4 |
| Trigger that is fired when the configured provider detects arrival. | |
| static const int32 | TRIGGER_TYPE_DEPARTURE = 5 |
| Trigger that is fired when the configured provider detects that the user has departed a given location. | |
Network Response | |
Success criteria constants for netwrok response. | |
| static const int32 | NETWORK_RESPONSE_CODE_ANY = 0x00000000 |
| static const int32 | NETWORK_RESPONSE_CODE_ANY_VALID = 0x00000001 |
| static const int32 | NETWORK_RESPONSE_CODE_2XX = 0x00000002 |
| static const int32 | NETWORK_RESPONSE_BODY_ANY = 0x00000000 |
| static const int32 | NETWORK_RESPONSE_BODY_NOT_EMPTY = 0x00000010 |
| static const int32 | NETWORK_RESPONSE_BODY_VALID_JSON = 0x00000030 |
CardTicket Replies | |
Supported card ticket replies. | |
| static const int32 | CARD_TICKET_REPLY_INACTIVE = 0x00000001 |
| static const int32 | CARD_TICKET_REPLY_NONE = 0x00000002 |
| static const int32 | CARD_TICKET_REPLY_ACCEPT = 0x00000004 |
| static const int32 | CARD_TICKET_REPLY_DECLINE = 0x00000008 |
| static const int32 | CARD_TICKET_REPLY_ANY |
Card States | |
Supported card states. | |
| static const int32 | CARD_STATE_NONE = 0x00000001 |
| Initial state of card object. More... | |
| static const int32 | CARD_STATE_CREATING = 0x00000002 |
| Card is in process of being created. | |
| static const int32 | CARD_STATE_PREVIEW = 0x00000004 |
| State representing the card decoded from invite. | |
| static const int32 | CARD_STATE_JOINING = 0x00000008 |
| The start card is turned into while client is waiting for acceptance from server. | |
| static const int32 | CARD_STATE_ACTIVE = 0x00000010 |
| Indicates completely initialized card maintained by card manager. | |
| static const int32 | CARD_STATE_LEAVING = 0x00000020 |
| User is in process of leaving the card. | |
| static const int32 | CARD_STATE_FAILED_TO_CREATE = 0x00000040 |
| Fatal state indicating failure to create a card. More... | |
| static const int32 | CARD_STATE_FAILED_TO_JOIN = 0x00000080 |
| Fatal state indicating failure to join a card. More... | |
Declares the list of all constants (enumerations) utilized by various API components.
|
inlinestatic |
This property controls whether invites of the associated linked account type are sent by the sever, or whether the host application perfers to send them itself.
By default, this property is false for all linked account types, so invites will be sent by the server.
|
static |
Fatal state indicating failure to create a card.
Card with this state should not be registered on card manager's list.
|
static |
Fatal state indicating failure to join a card.
Card with this state should not be registered on card manager's list.
|
static |
Initial state of card object.
Card exists in none state until it is registered on the manager.
|
static |
|
static |
The directions state is failed.
Directions were not successfully retrieved.
|
static |
The directions state is fetching.
Directions request has been sent to the server.
|
static |
The directions state is succeeded.
Directions were successfully retrieved.
|
static |
The directions state is unknown.
Normally prior to a directions request.
|
static |
In this mode ETA information should be provided externally.
Glympse API will not attempt to calclulate that.
|
static |
Only query eta/route when watched by someone, including self (i.e.
when platform is active).
|
static |
Ticket is automatically expired upon arrival.
GE::TICKET_EXPIRED is spread to ticket subscribers.
|
static |
The value indicates that client platform falls back to default lookback interval specified on server side.
It can be passed to IGlympse::setHistoryLookback() and returned by IGlympse::getHistoryLookback().
|
static |
Invite of unknown aspect.
The value usually indicates that invite aspect cannot be determined locally. See IGlympse::decodeInvite() for more details.
|
static |
Newly added standalone user will automatically be activated, if this mode is specified.
This mode only makes sense in conjunction with INVITE_MODE_DEFAULT, where users are added automatically.
|
static |
Default mode for invites decoding.
Platform starts viewing ticket invites automatically in this mode (without any confirmations).
Request invite will still result in GE::PLATFORM_INVITE_REQUEST being spread. Platform prevents automatic replying to ticket requests because of security considerations.
|
static |
Enables viewing confirmation for ticket invites.
GE::PLATFORM_INVITE_TICKET is spread to all subscribers of IGlympse event sink. Explicit action is required to start viewing ticket invite (see IGlympse::viewTicket()), if this mode is specified.
|
static |
The request failed because server disabled current platform installation.
Upon receiving this error platform will stop talking to Glympse server until it sees a change in application version.
|
static |
The default SMS send mode allows the Glympse API to query the device and determine if an SMS invite should be sent locally from the device's SMS number or remotely from the Glympse server SMS provider.
You can call the IGlympse::canDeviceSendSms method to determine if the Glympse API has detected that the device does support sending of SMS messages.
|
static |
|
static |
|
static |
When running in this mode, platform tracks and provides host application with updates regarding the only ticket for a given user (the most recently received one).
This ticket object is accessible through IUser::getActiveStandalone method. All other tickets received from the user remain on the list, but are never updated. The order of tickets changes only when new ticket is received from the user or currently active ticket expires.
User trail information is always available under track object belonging to active ticket. When active ticket changes, its track is merged with to newly activated ticket.
Platform automatically unsubscribes listeners from events spread by active ticket when it changes.
|
static |
Platform pulls updates for all active tickets received from a given user, when running in this mode.
User trail is still available through active standalone ticket. Major difference is that properties of all other tickets received from this user are also updated up until expiration.
In this mode platform never unsubscribes listeners of user's tickets.
1.8.4
