Represents a request for retrieving Experience Composer renderers. (OpenTok.ListRendersAsync). More...
| Public Member Functions | |
| ListRendersRequest () | |
| Initializes a ListRendersRequest with default values. The Count is set to 50. More... | |
| ListRendersRequest (int count) | |
| Initializes a ListRendersRequest. More... | |
| ListRendersRequest (int offset, int count) | |
| Initializes a ListRendersRequest. More... | |
| string | ToQueryParameters () |
| Converts the request to query parameters. More... |
| Public Attributes | |
| const string | CountExceeded = "Count cannot be higher than 1000." |
| Indicates the maximum count has been exceeded. More... | |
| const string | NegativeCount = "Count cannot be negative." |
| Indicates the provided count is negative. More... | |
| const string | NegativeOffset = "Offset cannot be negative." |
| Indicates the provided offset is negative. More... |
| Properties | |
| int? | Offset [get] |
| The start offset in the list of existing Renders. More... | |
| int | Count [get] |
| The number of Renders to retrieve, starting at offset. More... |
Detailed Description
Represents a request for retrieving Experience Composer renderers. (OpenTok.ListRendersAsync).
Constructor & Destructor Documentation
ListRendersRequest() [1/3]
| OpenTokSDK.Render.ListRendersRequest.ListRendersRequest | ( | ) |
Initializes a ListRendersRequest with default values. The Count is set to 50.
ListRendersRequest() [2/3]
| OpenTokSDK.Render.ListRendersRequest.ListRendersRequest | ( | int | count | ) |
Initializes a ListRendersRequest.
Parameters : | | | | --- | --- | | count | The number of Renders to retrieve starting at the offset. The default is 50, and the maximum is 1000. |
ListRendersRequest() [3/3]
| OpenTokSDK.Render.ListRendersRequest.ListRendersRequest | ( | int | offset, |
| int | count | ||
| ) |
Initializes a ListRendersRequest.
Parameters : | | | | --- | --- | | offset | The start offset in the list of existing Renders. | | count | The number of Renders to retrieve, starting at offset. The default is 50, and the maximum is 1000. |
Member Function Documentation
ToQueryParameters()
| string OpenTokSDK.Render.ListRendersRequest.ToQueryParameters | ( | ) |
Converts the request to query parameters.
Returns : The query parameters equivalent.
Member Data Documentation
CountExceeded
| const string OpenTokSDK.Render.ListRendersRequest.CountExceeded = "Count cannot be higher than 1000." |
Indicates the maximum count has been exceeded.
NegativeCount
| const string OpenTokSDK.Render.ListRendersRequest.NegativeCount = "Count cannot be negative." |
Indicates the provided count is negative.
NegativeOffset
| const string OpenTokSDK.Render.ListRendersRequest.NegativeOffset = "Offset cannot be negative." |
Indicates the provided offset is negative.
Property Documentation
Count
The number of Renders to retrieve, starting at offset.
Offset
The start offset in the list of existing Renders.