Represents a request for retrieving Experience Composer renderers. (OpenTok.ListRendersAsync).
More...
|
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...
|
|
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...
|
Represents a request for retrieving Experience Composer renderers. (OpenTok.ListRendersAsync).
◆ ListRendersRequest() [1/3]
OpenTokSDK.Render.ListRendersRequest.ListRendersRequest |
( |
| ) |
|
◆ 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. |
◆ ToQueryParameters()
string OpenTokSDK.Render.ListRendersRequest.ToQueryParameters |
( |
| ) |
|
Converts the request to query parameters.
- Returns
- The query parameters equivalent.
◆ 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.
◆ Count
int OpenTokSDK.Render.ListRendersRequest.Count |
|
The number of Renders to retrieve, starting at offset.
◆ Offset
int? OpenTokSDK.Render.ListRendersRequest.Offset |
|
The start offset in the list of existing Renders.