Skip to content

Latest commit

 

History

History
352 lines (238 loc) · 9.29 KB

NotificationApi.md

File metadata and controls

352 lines (238 loc) · 9.29 KB

Swagger\Client\NotificationApi

All URIs are relative to https://localhost

Method HTTP request Description
ackToasts GET /core/acktoasts
addNotificationFilter POST /core/addnotificationfilter
deleteToasts GET /core/deletetoasts
getNotificationStream POST /core/getnotificationstream
getToasts GET /core/gettoasts
isNotificationFilterSet POST /core/isnotificationfilterset
removeNotificationFilter POST /core/removenotificationfilter

ackToasts

string ackToasts($acktoastids)

Acknowledge the user alert notifications

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$acktoastids = "acktoastids_example"; // string | Specify the toast id

try {
    $result = $apiInstance->ackToasts($acktoastids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->ackToasts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
acktoastids string Specify the toast id

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

addNotificationFilter

string addNotificationFilter($path)

Add notification filter to a shared file/folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$path = "path_example"; // string | Path name

try {
    $result = $apiInstance->addNotificationFilter($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->addNotificationFilter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
path string Path name

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: Not defined

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

deleteToasts

string deleteToasts($toastrid, $clearallforuser)

Delete a user alerts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$toastrid = "toastrid_example"; // string | Specify the toast id
$clearallforuser = "clearallforuser_example"; // string | (optional) Specify the username (Incase you want to clear all the user alerts for a single user)

try {
    $result = $apiInstance->deleteToasts($toastrid, $clearallforuser);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->deleteToasts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
toastrid string Specify the toast id
clearallforuser string (optional) Specify the username (Incase you want to clear all the user alerts for a single user) [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getNotificationStream

string getNotificationStream()

Get the list of notifications

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getNotificationStream();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->getNotificationStream: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getToasts

string getToasts()

Get the list of user alert Notifications

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getToasts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->getToasts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

isNotificationFilterSet

string isNotificationFilterSet($path)

Is notification filter set or not of a shared file/folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$path = "path_example"; // string | Path name

try {
    $result = $apiInstance->isNotificationFilterSet($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->isNotificationFilterSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
path string Path name

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: Not defined

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

removeNotificationFilter

string removeNotificationFilter($path)

Remove notification filter of a shared file/folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\NotificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$path = "path_example"; // string | Path name

try {
    $result = $apiInstance->removeNotificationFilter($path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->removeNotificationFilter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
path string Path name

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: Not defined

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