EMOobRegistrationManager

Objective-C

@protocol EMOobRegistrationManager

Swift

protocol EMOobRegistrationManager

Interface for registering the user to the OOBS.

Since

3.0
  • Performs the registration of the user to the OOBS: The synchronous variant.

    Since

    3.0

    Declaration

    Objective-C

    - (id<EMOobRegistrationResponse>)registerWithRequest:
                                         (EMOobRegistrationRequest *)aRequest
                                                   error:(NSError **)anError;

    Swift

    func register(with aRequest: EMOobRegistrationRequest!) throws -> any EMOobRegistrationResponse

    Parameters

    aRequest

    The request object carrying all the data required by the OOBS in order to register the user to it.

    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.

    Return Value

    The registration response object.

  • Performs the registration of the user to the OOBS: The synchronous variant.

    Since

    4.7

    Declaration

    Objective-C

    - (id<EMOobRegistrationResponse>)
        registerWithRequest:(EMOobRegistrationRequest *)aRequest
           requestParameter:(EMOobRequestParameter *)aParam
                      error:(NSError **)anError;

    Swift

    func register(with aRequest: EMOobRegistrationRequest!, requestParameter aParam: EMOobRequestParameter!) throws -> any EMOobRegistrationResponse

    Parameters

    aRequest

    The request object carrying all the data required by the OOBS in order to register the user to it.

    aParam

    The request parameter object carrying the additional parameters, i.e. custom HTTP headers.

    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.

    Return Value

    The registration response object.

  • Performs the registration of the user to the OOBS: The asynchronous variant.

    Warning

    This method is executed asynchronously

    Since

    3.0

    Declaration

    Objective-C

    - (void)registerWithRequest:(EMOobRegistrationRequest *)aRequest
              completionHandler:(void (^)(id<EMOobRegistrationResponse>,
                                          NSError *))aCompletionHandler;

    Swift

    func register(with aRequest: EMOobRegistrationRequest!) async throws -> (any EMOobRegistrationResponse)?

    Parameters

    aRequest

    The request object carrying all the data required by the OOBS in order to register the user to it.

    aCompletionHandler

    The block to invoke on the main thread upon completion which contains the response and error information if any.

  • Performs the registration of the user to the OOBS: The asynchronous variant.

    Warning

    This method is executed asynchronously

    Since

    4.7

    Declaration

    Objective-C

    - (void)registerWithRequest:(EMOobRegistrationRequest *)aRequest
               requestParameter:(EMOobRequestParameter *)aParam
              completionHandler:(void (^)(id<EMOobRegistrationResponse>,
                                          NSError *))aCompletionHandler;

    Swift

    func register(with aRequest: EMOobRegistrationRequest!, requestParameter aParam: EMOobRequestParameter!) async throws -> (any EMOobRegistrationResponse)?

    Parameters

    aRequest

    The request object carrying all the data required by the OOBS in order to register the user to it.

    aParam

    The request parameter object carrying the additional parameters, i.e. custom HTTP headers.

    aCompletionHandler

    The block to invoke on the main thread upon completion which contains the response and error information if any.