Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.63 KB

SWGNotificationApi.md

File metadata and controls

72 lines (49 loc) · 2.63 KB

SWGNotificationApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
notificationGet GET /notification Get your current notifications.

notificationGet

-(NSURLSessionTask*) notificationGetWithCompletionHandler: 
        (void (^)(NSArray<SWGNotification>* output, NSError* error)) handler;

Get your current notifications.

This is an upcoming feature and currently does not return data.

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-key"];

// Configure API key authorization: (authentication scheme: apiNonce)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-nonce"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-nonce"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-signature"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-signature"];



SWGNotificationApi*apiInstance = [[SWGNotificationApi alloc] init];

// Get your current notifications.
[apiInstance notificationGetWithCompletionHandler: 
          ^(NSArray<SWGNotification>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGNotificationApi->notificationGet: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

NSArray*

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]