com.bbm.sdk.bbmds

Class Global

java.lang.Object

com.bbm.sdk.bbmds.internal.RequestListActions

com.bbm.sdk.bbmds.Global

All Implemented Interfaces:

JsonConstructable

Direct Known Subclasses:

GlobalAuthTokenState, GlobalChatMessageFileAutoDownload, GlobalEndpointId, GlobalLocalPin, GlobalLocalUri, GlobalProfileKeysState, GlobalRegistrationToken, GlobalSetupAccount, GlobalSetupState, GlobalSyncing, GlobalSyncPasscodeState

public class Global
extends RequestListActions
implements JsonConstructable

This list holds the set of global variables exchanged between your application and bbmcore. The list uses string keys and mixed-type values. The key is the variable name. The set of valid variables and their meaning is documented in the 'globals' section.

Since:

R0

Field Summary

Fields

Modifier and Type	Field and Description
Existence	exists Determines whether the data in this object is valid.
java.lang.String	name String name of the global variable.

Constructor Summary

Constructors

Constructor and Description
Global() Creates a new instance with default values
Global(Global toCopy) Creates a shallow copy of the argument.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Existence	getExists() See Existence
java.lang.String	getPrimaryKey() Provides the unique key for this Global
int	hashCode()
Global	setAttributes(JSONObject json) Updates the the attributes of the Global based on the values in the JSONObject
void	setExists(Existence exists) See Existence
JsonConstructable	shallowCopy() Creates a shallow copy of the receiver
java.lang.String	toString()

Methods inherited from class com.bbm.sdk.bbmds.internal.RequestListActions

requestListAdd, requestListChange, requestListRemove

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

String name of the global variable. This list has a closed set of valid variable names. See the 'global' section for information about the set of variables and their semantics.

Since:

R0

exists

public Existence exists

Determines whether the data in this object is valid. If state is Existence.YES, this object contains real data. Otherwise, all other attributes contain default placeholder data. If the state is Existence.NO, then we know for certain that this entity does not exist in bbmcore. If the state is Existence.MAYBE, then we have not yet confirmed whether this entity exists in bbmcore -- normally because a request has been sent to bbmcore that it has not yet answered.

Constructor Detail

Global

public Global()

Creates a new instance with default values

Global

public Global(Global toCopy)

Creates a shallow copy of the argument.

Parameters:

toCopy - the object to copy

Method Detail

getPrimaryKey

public java.lang.String getPrimaryKey()

Provides the unique key for this Global

Specified by:

getPrimaryKey in interface JsonConstructable

Returns:

unique key

Since:

R3

setAttributes

public Global setAttributes(JSONObject json)

Updates the the attributes of the Global based on the values in the JSONObject

Specified by:

setAttributes in interface JsonConstructable

Parameters:

json - The JSONObject used to update the attributes of this Global

Returns:

The Global after it has been updated.

Since:

R0

shallowCopy

public JsonConstructable shallowCopy()

Description copied from interface: JsonConstructable

Creates a shallow copy of the receiver

Specified by:

shallowCopy in interface JsonConstructable

Returns:

a shallow copy of the receiver

setExists

public void setExists(Existence exists)

Description copied from interface: JsonConstructable

See Existence

Specified by:

setExists in interface JsonConstructable

Parameters:

exists - sets the expected Existence value on the object.

getExists

public Existence getExists()

Description copied from interface: JsonConstructable

See Existence

Specified by:

getExists in interface JsonConstructable

Returns:

One of Existence.MAYBE, Existence.YES or Existence.NO

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object