EMOobNotificationManager Protocol Reference
| Conforms to | NSObject |
|---|---|
| Declared in | EMOobNotificationManager.h |
Overview
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).
– notificationProfiles:
required method
Retrieves the list of notification profiles from the server.
- (id<EMOobNotificationProfilesResponse>)notificationProfiles:(NSError **)anErrorParameters
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 |
|---|
Return Value
The list of notification profiles associated with the current client.
Availability
3.0
Discussion
This method is long-running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– notificationProfilesWithRequestParameter:error:
required method
Retrieves the list of notification profiles from the server.
- (id<EMOobNotificationProfilesResponse>)notificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam error:(NSError **)anErrorParameters
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 |
Return Value
The list of notification profiles associated with the current client.
Availability
4.7
Discussion
This method is long-running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– setNotificationProfiles:error:
required method
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.
- (id<EMOobResponse>)setNotificationProfiles:(NSArray *)aNotificationProfiles error:(NSError **)anErrorParameters
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 |
Return Value
The result of the request.
Availability
3.0
Discussion
This method is long running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– setNotificationProfiles:requestParameter:error:
required method
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.
- (id<EMOobResponse>)setNotificationProfiles:(NSArray *)aNotificationProfiles requestParameter:(EMOobRequestParameter *)aParam error:(NSError **)anErrorParameters
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 |
Return Value
The result of the request.
Availability
4.7
Discussion
This method is long running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– clearNotificationProfiles:
required method
Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.
- (id<EMOobResponse>)clearNotificationProfiles:(NSError **)anErrorParameters
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 |
|---|
Return Value
The response of the request.
Availability
3.0
Discussion
This method is long-running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– clearNotificationProfilesWithRequestParameter:error:
required method
Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.
- (id<EMOobResponse>)clearNotificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam error:(NSError **)anErrorParameters
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 |
Return Value
The response of the request.
Availability
4.7
Discussion
This method is long-running and should not be executed on the UI thread.
Declared In
EMOobNotificationManager.h
– notificationProfilesWithCompletionHandler:
required method
Retrieves the list of notification profiles from the server.
- (void)notificationProfilesWithCompletionHandler:(void ( ^ ) ( id<EMOobNotificationProfilesResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
aCompletionHandler |
The block to invoke on the main thread upon completion which contains the response and error information if any. |
|---|
Availability
3.0
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h
– notificationProfilesWithRequestParameter:completionHandler:
required method
Retrieves the list of notification profiles from the server.
- (void)notificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam completionHandler:(void ( ^ ) ( id<EMOobNotificationProfilesResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
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. |
Availability
4.7
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h
– setNotificationProfiles:completionHandler:
required method
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.
- (void)setNotificationProfiles:(NSArray *)aNotificationProfiles completionHandler:(void ( ^ ) ( id<EMOobResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
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. |
Availability
3.0
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h
– setNotificationProfiles:requestParameter:completionHandler:
required method
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.
- (void)setNotificationProfiles:(NSArray *)aNotificationProfiles requestParameter:(EMOobRequestParameter *)aParam completionHandler:(void ( ^ ) ( id<EMOobResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
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. |
Availability
4.7
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h
– clearNotificationProfilesWithCompletionHandler:
required method
Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.
- (void)clearNotificationProfilesWithCompletionHandler:(void ( ^ ) ( id<EMOobResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
aCompletionHandler |
The block to invoke on the main thread upon completion which contains the response and error information if any. |
|---|
Availability
3.0
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h
– clearNotificationProfilesWithRequestParameter:completionHandler:
required method
Clears (removes all) the current client notification profiles. This will leave the client with no notification profile.
- (void)clearNotificationProfilesWithRequestParameter:(EMOobRequestParameter *)aParam completionHandler:(void ( ^ ) ( id<EMOobResponse> aResponse , NSError *anError ))aCompletionHandlerParameters
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. |
Availability
4.7
Discussion
Warning: This method is executed asynchronously
Declared In
EMOobNotificationManager.h