Method Detail

• createUser

   abstract CreateUserResponse createUser(String appId, Map<String, String> identities, List<SubscriptionObject> subscriptions, Map<String, String> properties)

  Create a user on the backend. If an identity provided already exists, this will result in updating that user and retrieving the net result as the response. Note that there must be at least 1 identity or 1 subscription.

  If there is a non-successful response from the backend, a BackendException will be thrown with response data.

  Parameters:

  appId - The ID of the OneSignal application this user will be created under.

  identities - The identities to retrieve/modify this user in subsequent requests.

  subscriptions - The subscriptions that should also be created and associated with the user.

  properties - The properties for this user.

• updateUser

   abstract RywData updateUser(String appId, String aliasLabel, String aliasValue, PropertiesObject properties, Boolean refreshDeviceMetadata, PropertiesDeltasObject propertyiesDelta)

  Update the user identified by the appId/aliasId/aliasLabel on the backend.

  If there is a non-successful response from the backend, a BackendException will be thrown with response data.

  Parameters:

  appId - The ID of the OneSignal application this user will be created under.

  aliasLabel - The alias label to retrieve the user under.

  aliasValue - The identifier within the aliasLabel that identifies the user to retrieve.

  properties - The properties for this user.

  refreshDeviceMetadata - Whether the backend should refresh the device metadata for this user.

  propertyiesDelta - The properties delta for this user.

• getUser

   abstract CreateUserResponse getUser(String appId, String aliasLabel, String aliasValue)

  Retrieve a user from the backend.

  If there is a non-successful response from the backend, a BackendException will be thrown with response data.

  Parameters:

  appId - The ID of the OneSignal application this user will be created under.

  aliasLabel - The alias label to retrieve the user under.

  aliasValue - The identifier within the aliasLabel that identifies the user to retrieve.