EMOobRegistrationRequest

Objective-C


@interface EMOobRegistrationRequest : NSObject

Swift

class EMOobRegistrationRequest : NSObject

OOB registration request object.

Since

3.0

  • Returns registration operation.

    Since

    3.0

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOobRegistrationMethod registrationMethod;

    Swift

    var registrationMethod: EMOobRegistrationMethod { get }

  • Returns the value of the registration code.

    Since

    3.0

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) id<EMSecureString> registrationParameter;

    Swift

    @NSCopying var registrationParameter: (any EMSecureString)! { get }

  • Returns the user ID of the user who registers to the OOBS.

    Since

    3.0

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *userId;

    Swift

    var userId: String! { get }

  • Returns the alias of the user who performs the registration.

    Since

    3.0

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *userAliasForClient;

    Swift

    var userAliasForClient: String! { get }

  • Returns The list of notification profile.

    Since

    3.0

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray *notificationProfileItems;

    Swift

    var notificationProfileItems: [Any]! { get }

  • Constructs the OOB registration request object: Variant w/o any notification endpoints set.

    Since

    3.0

    Declaration

    Objective-C

    - (id)initWithUserId:(NSString *)aUserId
       userAliasForClient:(NSString *)aUserAliasForClient
       registrationMethod:(EMOobRegistrationMethod)aRegistrationMethod
    registrationParameter:(id<EMSecureString>)aRegistrationParameter
                    error:(NSError **)anError;

    Swift

    init(userId aUserId: String!, userAliasForClient aUserAliasForClient: String!, registrationMethod aRegistrationMethod: EMOobRegistrationMethod, registrationParameter aRegistrationParameter: (any EMSecureString)!) throws

    Parameters

    aUserId

    The ID of the user who registers to the OOBS.
    aUserAliasForClient

    The alias of the user who performs th registration.
    aRegistrationMethod

    The registration method to be used for the registration to the OOBS.
    aRegistrationParameter

    The registration parameter. Its meaning depends on the value of the registration method - see previous parameter.
    anError

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

  • Constructs the OOB registration request object: Variant with the notification endpoints set.

    Since

    3.0

    Declaration

    Objective-C

    - (id)initWithUserId:(NSString *)aUserId
          userAliasForClient:(NSString *)aUserAliasForClient
          registrationMethod:(EMOobRegistrationMethod)aRegistrationMethod
       registrationParameter:(id<EMSecureString>)aRegistrationParameter
    notificationProfileItems:(NSArray *)aNotificationProfileItems
                       error:(NSError **)anError;

    Swift

    init(userId aUserId: String!, userAliasForClient aUserAliasForClient: String!, registrationMethod aRegistrationMethod: EMOobRegistrationMethod, registrationParameter aRegistrationParameter: (any EMSecureString)!, notificationProfileItems aNotificationProfileItems: [Any]!) throws

    Parameters

    aUserId

    The ID of the user who registers to the OOBS.
    aUserAliasForClient

    The alias of the user who performs th registration.
    aNotificationProfileItems

    The notification endpoints to initially add to the currently being registered user.
    aRegistrationMethod

    The registration method to be used for the registration to the OOBS.
    aRegistrationParameter

    The registration parameter. Its meaning depends on the value of the registration method - see previous parameter.
    anError

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

  • Used by the SDK to wipe any sensitive data managed by this object when it is no longer needed.

    Since

    3.0

    Declaration

    Objective-C

    - (void)wipe;

    Swift

    func wipe()