public class NotificationsApi extends Object
Modifier and Type | Field and Description |
---|---|
EmailsApi |
emails |
StatesApi |
states |
WebhooksApi |
webhooks |
Constructor and Description |
---|
NotificationsApi(BitmovinApiClientFactory clientFactory) |
Modifier and Type | Method and Description |
---|---|
static BitmovinApiBuilder<NotificationsApi> |
builder()
Fluent builder for creating an instance of NotificationsApi
|
BitmovinResponse |
delete(String notificationId)
Delete Notification
|
Notification |
get(String notificationId)
Get Notification
|
PaginationResponse<Notification> |
list()
List Notifications
|
PaginationResponse<Notification> |
list(NotificationListQueryParams queryParams)
List Notifications
|
PaginationResponse<NotificationStateEntry> |
listByNotificationId(String notificationId)
List Notification State History (All Resources)
|
PaginationResponse<NotificationStateEntry> |
listByNotificationId(String notificationId,
NotificationStateEntryListByNotificationIdQueryParams queryParams)
List Notification State History (All Resources)
|
BitmovinResponse |
mute(String notificationId)
Mute Notification
|
BitmovinResponse |
unmute(String notificationId)
Unmute Notification
|
public final WebhooksApi webhooks
public final StatesApi states
public final EmailsApi emails
public NotificationsApi(BitmovinApiClientFactory clientFactory)
public static BitmovinApiBuilder<NotificationsApi> builder()
public BitmovinResponse delete(String notificationId) throws BitmovinException
notificationId
- Id of the notification (required)BitmovinException
- if fails to make API callpublic Notification get(String notificationId) throws BitmovinException
notificationId
- Id of the notification (required)BitmovinException
- if fails to make API callpublic PaginationResponse<Notification> list() throws BitmovinException
BitmovinException
- if fails to make API callpublic PaginationResponse<Notification> list(NotificationListQueryParams queryParams) throws BitmovinException
queryParams
- The query parameters for sorting, filtering and paging options (optional)BitmovinException
- if fails to make API callpublic PaginationResponse<NotificationStateEntry> listByNotificationId(String notificationId) throws BitmovinException
notificationId
- Id of the notification (required)BitmovinException
- if fails to make API callpublic PaginationResponse<NotificationStateEntry> listByNotificationId(String notificationId, NotificationStateEntryListByNotificationIdQueryParams queryParams) throws BitmovinException
notificationId
- Id of the notification (required)queryParams
- The query parameters for sorting, filtering and paging options (optional)BitmovinException
- if fails to make API callpublic BitmovinResponse mute(String notificationId) throws BitmovinException
notificationId
- Id of the notification (required)BitmovinException
- if fails to make API callpublic BitmovinResponse unmute(String notificationId) throws BitmovinException
notificationId
- Id of the notification (required)BitmovinException
- if fails to make API callCopyright © 2020. All rights reserved.