-
- All Implemented Interfaces:
-
com.onesignal.common.events.IEventNotifier
public final class LoginUserOperation extends Operation
An Operation to login the user with the externalId provided. Logging in a user will do the following:
Attempt to give the user identified by existingOnesignalId an alias of externalId. If this succeeds the existing user becomes
-
-
Field Summary
Fields Modifier and Type Field Description private StringappIdprivate StringonesignalIdprivate StringexternalIdprivate StringexistingOnesignalIdprivate final StringcreateComparisonKeyprivate final StringmodifyComparisonKeyprivate final GroupComparisonTypegroupComparisonTypeprivate final BooleancanStartExecuteprivate final StringapplyToRecordIdprivate Stringnameprivate Stringidprivate final BooleanhasSubscribers
-
Constructor Summary
Constructors Constructor Description LoginUserOperation(String appId, String onesignalId, String externalId, String existingOneSignalId)LoginUserOperation()
-
Method Summary
Modifier and Type Method Description final StringgetAppId()final UnitsetAppId(String appId)final StringgetOnesignalId()final UnitsetOnesignalId(String onesignalId)final StringgetExternalId()final UnitsetExternalId(String externalId)final StringgetExistingOnesignalId()final UnitsetExistingOnesignalId(String existingOnesignalId)StringgetCreateComparisonKey()StringgetModifyComparisonKey()The key of this operation for when the starting operation has a groupComparisonType of GroupComparisonType.ALTER GroupComparisonTypegetGroupComparisonType()The comparison type to use when this operation is the starting operation, in terms of which operations can be grouped with it. BooleangetCanStartExecute()StringgetApplyToRecordId()final StringgetName()final UnitsetName(String name)final StringgetId()final UnitsetId(String id)BooleangetHasSubscribers()UnittranslateIds(Map<String, String> map)Called when an operation has resolved a local ID to a backend ID (i.e. -
Methods inherited from class com.onesignal.user.internal.operations.LoginUserOperation
toString -
Methods inherited from class com.onesignal.core.internal.operations.Operation
hasProperty, initializeFromJson, initializeFromModel, setAnyProperty, setBigDecimalProperty, setBooleanProperty, setDoubleProperty, setEnumProperty, setFloatProperty, setIntProperty, setListProperty, setLongProperty, setMapModelProperty, setOptAnyProperty, setOptBigDecimalProperty, setOptBooleanProperty, setOptDoubleProperty, setOptEnumProperty, setOptFloatProperty, setOptIntProperty, setOptListProperty, setOptLongProperty, setOptMapModelProperty, setOptStringProperty, setStringProperty, subscribe, toJSON, unsubscribe -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getOnesignalId
final String getOnesignalId()
-
setOnesignalId
final Unit setOnesignalId(String onesignalId)
-
getExternalId
final String getExternalId()
-
setExternalId
final Unit setExternalId(String externalId)
-
getExistingOnesignalId
final String getExistingOnesignalId()
-
setExistingOnesignalId
final Unit setExistingOnesignalId(String existingOnesignalId)
-
getCreateComparisonKey
String getCreateComparisonKey()
-
getModifyComparisonKey
String getModifyComparisonKey()
The key of this operation for when the starting operation has a groupComparisonType of GroupComparisonType.ALTER
-
getGroupComparisonType
GroupComparisonType getGroupComparisonType()
The comparison type to use when this operation is the starting operation, in terms of which operations can be grouped with it.
-
getCanStartExecute
Boolean getCanStartExecute()
-
getApplyToRecordId
String getApplyToRecordId()
-
getHasSubscribers
Boolean getHasSubscribers()
-
translateIds
Unit translateIds(Map<String, String> map)
Called when an operation has resolved a local ID to a backend ID (i.e. successfully created a backend resource). Any IDs within the operation that could be local IDs should be translated at this time. Within the map the key is the local Id, the value is the remote Id.
-
-
-
-