@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
108 lines (107 loc) • 3.35 kB
TypeScript
import StreamsType from '../../models/StreamsType';
import StreamsVideoStatus from '../../models/StreamsVideoStatus';
export interface StreamsResponseListQueryParams {
/**
* Index of the first item to return, starting at 0. Default is 0
* @type {number}
* @memberof StreamsResponseListQueryParams
*/
offset?: number | undefined;
/**
* Maximum number of items to return. Default is 25, maximum is 100
* @type {number}
* @memberof StreamsResponseListQueryParams
*/
limit?: number | undefined;
/**
* Query to search for in a streams' title, description and ID
* @type {string}
* @memberof StreamsResponseListQueryParams
*/
query?: string | undefined;
/**
* Type of stream to search for
* @type {StreamsType}
* @memberof StreamsResponseListQueryParams
*/
type?: StreamsType | undefined;
/**
* Status of the streams to search for
* @type {StreamsVideoStatus}
* @memberof StreamsResponseListQueryParams
*/
status?: StreamsVideoStatus | undefined;
/**
* Upper limit for the creation date of found streams as UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
* @type {string}
* @memberof StreamsResponseListQueryParams
*/
createdBefore?: string | undefined;
/**
* Lower limit for the creation date of found streams as UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
* @type {string}
* @memberof StreamsResponseListQueryParams
*/
createdAfter?: string | undefined;
/**
* Filter for token-protected/signed streams
* @type {boolean}
* @memberof StreamsResponseListQueryParams
*/
signed?: boolean | undefined;
/**
* Filter for domain-restricted streams
* @type {boolean}
* @memberof StreamsResponseListQueryParams
*/
domainRestricted?: boolean | undefined;
}
export declare class StreamsResponseListQueryParamsBuilder {
private internalParams;
/**
*
* @param offset Index of the first item to return, starting at 0. Default is 0
*/
offset(offset: number): this;
/**
*
* @param limit Maximum number of items to return. Default is 25, maximum is 100
*/
limit(limit: number): this;
/**
*
* @param query Query to search for in a streams' title, description and ID
*/
query(query: string): this;
/**
*
* @param type Type of stream to search for
*/
type(type: StreamsType): this;
/**
*
* @param status Status of the streams to search for
*/
status(status: StreamsVideoStatus): this;
/**
*
* @param createdBefore Upper limit for the creation date of found streams as UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
createdBefore(createdBefore: string): this;
/**
*
* @param createdAfter Lower limit for the creation date of found streams as UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
createdAfter(createdAfter: string): this;
/**
*
* @param signed Filter for token-protected/signed streams
*/
signed(signed: boolean): this;
/**
*
* @param domainRestricted Filter for domain-restricted streams
*/
domainRestricted(domainRestricted: boolean): this;
buildQueryParams(): StreamsResponseListQueryParams;
}