public final class IdentitiesGet extends BbmdsProtocol.OutboundMessage
Requests that the given list of identities, either application user ids or Spark Communications regIds, be resolved to find the associated identity information, and returned via an 'identities' message.
Identities for which identity information cannot be found are omitted from the results.
Overlapping 'identitiesGet' requests are issued in parallel. Issuing too many parallel requests at once can exceed system limits and cause those requests to fail.
|Constructor and Description|
Creates a new outbound 'identitiesGet' message.
|Modifier and Type||Method and Description|
Sets the optional 'appUserIds' attribute on the message
Sets the optional 'regIds' attribute on the message
public IdentitiesGet(java.lang.String cookie)
cookie- An opaque value to be returned in the associated 'identities' response.
public IdentitiesGet appUserIds(java.util.List<java.lang.String> value)
value- A list of application user ids to lookup. Either this or 'regIds' must be specified.
public IdentitiesGet regIds(java.util.List<java.lang.Long> value)
A list of Spark Communications regIds to lookup. Either this or 'appUserIds' must be specified.
A maximum of 50 identities can be present in one request. If more identities are present, 'identities' will return a 'Failure'.