Class NotificationsApi
Inheritance
System.Object
NotificationsApi
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Notifications
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class NotificationsApiConstructors
NotificationsApi(IBitmovinApiClientFactory)
Declaration
public NotificationsApi(IBitmovinApiClientFactory apiClientFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of NotificationsApi
Declaration
public static BitmovinApiBuilder<NotificationsApi> Builder { get; }Property Value
| Type | Description |
|---|---|
| BitmovinApiBuilder<NotificationsApi> |
Emails
Declaration
public EmailsApi Emails { get; }Property Value
| Type | Description |
|---|---|
| EmailsApi |
States
Declaration
public StatesApi States { get; }Property Value
| Type | Description |
|---|---|
| StatesApi |
Webhooks
Declaration
public WebhooksApi Webhooks { get; }Property Value
| Type | Description |
|---|---|
| WebhooksApi |
Methods
DeleteAsync(String)
Delete Notification
Declaration
public Task<BitmovinResponse> DeleteAsync(string notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | notificationId | Id of the notification (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
GetAsync(String)
Get Notification
Declaration
public Task<Notification> GetAsync(string notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | notificationId | Id of the notification (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Notification> |
ListAsync(Func<NotificationsApi.ListQueryParams, NotificationsApi.ListQueryParams>[])
List Notifications
Declaration
public Task<PaginationResponse<Notification>> ListAsync(params Func<NotificationsApi.ListQueryParams, NotificationsApi.ListQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<NotificationsApi.ListQueryParams, NotificationsApi.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<Notification>> |
ListByNotificationIdAsync(String, Func<NotificationsApi.ListByNotificationIdQueryParams, NotificationsApi.ListByNotificationIdQueryParams>[])
List Notification State History (All Resources)
Declaration
public Task<PaginationResponse<NotificationStateEntry>> ListByNotificationIdAsync(string notificationId, params Func<NotificationsApi.ListByNotificationIdQueryParams, NotificationsApi.ListByNotificationIdQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | notificationId | Id of the notification (required) |
| System.Func<NotificationsApi.ListByNotificationIdQueryParams, NotificationsApi.ListByNotificationIdQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<NotificationStateEntry>> |
MuteAsync(String)
Mute Notification
Declaration
public Task<BitmovinResponse> MuteAsync(string notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | notificationId | Id of the notification (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
UnmuteAsync(String)
Unmute Notification
Declaration
public Task<BitmovinResponse> UnmuteAsync(string notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | notificationId | Id of the notification (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |