EMOobNotificationManager

Objective-C

@protocol EMOobNotificationManager <NSObject>

Swift

protocol EMOobNotificationManager : NSObjectProtocol

The manager that provides functionality to manage a user notification profile. A notification profile is a list of EMOobNotificationProfile objects. Each notification profile contains a channel (SMS, Push, email, etc.) and an end point attached to that channel (for example an email address for the case of an email channel).

Since

3.0

  • Retrieves the list of notification profiles from the server.

    This method is long-running and should not be executed on the UI thread.

    Since

    3.0

    Declaration

    Objective-C

    - (id<EMOobNotificationProfilesResponse>)notificationProfiles:
    (NSError **)anError;

    Swift

    func notificationProfiles() throws -> any EMOobNotificationProfilesResponse

    Parameters

    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 list of notification profiles associated with the current client.

  • Retrieves the list of notification profiles from the server.

    This method is long-running and should not be executed on the UI thread.

    Since

    4.7

    Declaration

    Objective-C

    - (id<EMOobNotificationProfilesResponse>)
    notificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam
                                       error:(NSError **)anError;

    Swift

    func notificationProfiles(with aParam: EMOobRequestParameter!) throws -> any EMOobNotificationProfilesResponse

    Parameters

    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 list of notification profiles associated with the current client.

  • Sets or updates the list of notification profiles of the current client. If the list has already been set, it will be replaced by this new list.

    This method is long running and should not be executed on the UI thread.

    Since

    3.0

    Declaration

    Objective-C

    - (id<EMOobResponse>)setNotificationProfiles:(NSArray *)aNotificationProfiles
                                       error:(NSError **)anError;

    Swift

    func setNotificationProfiles(_ aNotificationProfiles: [Any]!) throws -> any EMOobResponse

    Parameters

    aNotificationProfiles

    A list of one or more notification profile to set as the new notification profile.
    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 result of the request.

  • Sets or updates the list of notification profiles of the current client. If the list has already been set, it will be replaced by this new list.

    This method is long running and should not be executed on the UI thread.

    Since

    4.7

    Declaration

    Objective-C

    - (id<EMOobResponse>)setNotificationProfiles:(NSArray *)aNotificationProfiles
                            requestParameter:(EMOobRequestParameter *)aParam
                                       error:(NSError **)anError;

    Swift

    func setNotificationProfiles(_ aNotificationProfiles: [Any]!, requestParameter aParam: EMOobRequestParameter!) throws -> any EMOobResponse

    Parameters

    aNotificationProfiles

    A list of one or more notification profile to set as the new notification profile.
    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 result of the request.

  • Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.

    This method is long-running and should not be executed on the UI thread.

    Since

    3.0

    Declaration

    Objective-C

    - (id<EMOobResponse>)clearNotificationProfiles:(NSError **)anError;

    Swift

    func clearNotificationProfiles() throws -> any EMOobResponse

    Parameters

    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 response of the request.

  • Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.

    This method is long-running and should not be executed on the UI thread.

    Since

    4.7

    Declaration

    Objective-C

    - (id<EMOobResponse>)clearNotificationProfilesWithRequestParameter:
                         (EMOobRequestParameter *)aParam
                                                             error:(NSError **)
                                                                       anError;

    Swift

    func clearNotificationProfiles(with aParam: EMOobRequestParameter!) throws -> any EMOobResponse

    Parameters

    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 response of the request.

  • Retrieves the list of notification profiles from the server.

    Warning

    This method is executed asynchronously

    Since

    3.0

    Declaration

    Objective-C

    - (void)notificationProfilesWithCompletionHandler:
    (void (^)(id<EMOobNotificationProfilesResponse>,
              NSError *))aCompletionHandler;

    Swift

    func notificationProfiles() async throws -> (any EMOobNotificationProfilesResponse)?

    Parameters

    aCompletionHandler

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

  • Retrieves the list of notification profiles from the server.

    Warning

    This method is executed asynchronously

    Since

    4.7

    Declaration

    Objective-C

    - (void)
    notificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam
                           completionHandler:
                               (void (^)(id<EMOobNotificationProfilesResponse>,
                                         NSError *))aCompletionHandler;

    Swift

    func notificationProfiles(with aParam: EMOobRequestParameter!) async throws -> (any EMOobNotificationProfilesResponse)?

    Parameters

    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.

  • Sets or updates the list of notification profiles of the current client. If the list has already been set, it will be replaced by this new list.

    Warning

    This method is executed asynchronously

    Since

    3.0

    Declaration

    Objective-C

    - (void)setNotificationProfiles:(NSArray *)aNotificationProfiles
              completionHandler:
                  (void (^)(id<EMOobResponse>, NSError *))aCompletionHandler;

    Swift

    func setNotificationProfiles(_ aNotificationProfiles: [Any]!) async throws -> (any EMOobResponse)?

    Parameters

    aNotificationProfiles

    A list of one ore more notification profiles to set.
    aCompletionHandler

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

  • Sets or updates the list of notification profiles of the current client. If the list has already been set, it will be replaced by this new list.

    Warning

    This method is executed asynchronously

    Since

    4.7

    Declaration

    Objective-C

    - (void)setNotificationProfiles:(NSArray *)aNotificationProfiles
               requestParameter:(EMOobRequestParameter *)aParam
              completionHandler:
                  (void (^)(id<EMOobResponse>, NSError *))aCompletionHandler;

    Swift

    func setNotificationProfiles(_ aNotificationProfiles: [Any]!, requestParameter aParam: EMOobRequestParameter!) async throws -> (any EMOobResponse)?

    Parameters

    aNotificationProfiles

    A list of one ore more notification profiles to set.
    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.

  • Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.

    Warning

    This method is executed asynchronously

    Since

    3.0

    Declaration

    Objective-C

    - (void)clearNotificationProfilesWithCompletionHandler:
    (void (^)(id<EMOobResponse>, NSError *))aCompletionHandler;

    Swift

    func clearNotificationProfiles() async throws -> (any EMOobResponse)?

    Parameters

    aCompletionHandler

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

  • Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.

    Warning

    This method is executed asynchronously

    Since

    4.7

    Declaration

    Objective-C

    - (void)clearNotificationProfilesWithRequestParameter:
            (EMOobRequestParameter *)aParam
                                    completionHandler:
                                        (void (^)(id<EMOobResponse>,
                                                  NSError *))aCompletionHandler;

    Swift

    func clearNotificationProfiles(with aParam: EMOobRequestParameter!) async throws -> (any EMOobResponse)?

    Parameters

    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.