com.bitmovin.api.sdk.notifications.states

Class StatesApi

java.lang.Object

com.bitmovin.api.sdk.notifications.states.StatesApi

public class StatesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
StatesApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<StatesApi>	builder() Fluent builder for creating an instance of StatesApi
PaginationResponse<NotificationStateEntry>	list(String notificationId, String resourceId) List Notification State History (Specific Resource)
PaginationResponse<NotificationStateEntry>	list(String notificationId, String resourceId, NotificationStateEntryListQueryParams queryParams) List Notification State History (Specific Resource)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatesApi

public StatesApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<StatesApi> builder()

Fluent builder for creating an instance of StatesApi

list

public PaginationResponse<NotificationStateEntry> list(String notificationId,
                                                       String resourceId)
                                                throws BitmovinException

List Notification State History (Specific Resource)

Parameters:

notificationId - Id of the notification (required)

resourceId - Id of the resource, e.g. encoding id (required)

Returns:

List<NotificationStateEntry>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<NotificationStateEntry> list(String notificationId,
                                                       String resourceId,
                                                       NotificationStateEntryListQueryParams queryParams)
                                                throws BitmovinException

List Notification State History (Specific Resource)

Parameters:

notificationId - Id of the notification (required)

resourceId - Id of the resource, e.g. encoding id (required)

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<NotificationStateEntry>

Throws:

BitmovinException - if fails to make API call