Class AbstractGetMediaRequest<T>`Abstract`

Abstract class to represent requests related to media info.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.2.0

Type Parameters

T extends AbstractResponse<unknown>

Hierarchy

AbstractRequest<T>
- AbstractGetMediaRequest

Index

Constructors

`Protected` constructor

new AbstractGetMediaRequest<T>(accessToken: string, ...fields: MediaField[]): AbstractGetMediaRequest<T>
The constructor.
Type Parameters
- T extends AbstractResponse<unknown, T>
Parameters
- accessToken: string
  
  the access token.
- Rest ...fields: MediaField[]
  
  the fields to retrieve from the API. If no field is specified, all are retrieved.
Returns AbstractGetMediaRequest<T>
Overrides AbstractRequest.constructor
- Defined in main/requests/AbstractGetMediaRequest.ts:19

Properties

`Protected` `Optional` apiVersion

apiVersion?: ApiVersion

The API Version.

`Protected` params

params: Params

The request params.

Methods

addLimit

addLimit(limit: number): void
Adds the limit param to the request.

Deprecated
since 1.7.0, use withLimit instead.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns void
Inherited from AbstractRequest.addLimit
- Defined in main/requests/AbstractRequest.ts:103

addPaging

addPaging(pageOptionToken: PageOptionToken): void
Adds a paging param to the request.

Deprecated
since 1.7.0, use withPaging instead.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns void
Inherited from AbstractRequest.addPaging
- Defined in main/requests/AbstractRequest.ts:77

addRange

addRange(since: Date, until: Date): void
Adds the range params to the request.

Deprecated
since 1.7.0, use withRange instead.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns void
Inherited from AbstractRequest.addRange
- Defined in main/requests/AbstractRequest.ts:91

config

config(): RequestConfig
Builds the config of the request.

Returns
the request config.

Returns RequestConfig
Inherited from AbstractRequest.config
- Defined in main/requests/AbstractRequest.ts:50

execute

execute(): Promise<T>
Executes the requests and returns a promise of the parsed response.

Returns
the promise of a parsed response.

Returns Promise<T>
Inherited from AbstractRequest.execute
- Defined in main/requests/AbstractRequest.ts:64

`Protected` method

method(): Method
Gets the method for the request.

Returns
the method for the request.

Returns Method
Inherited from AbstractRequest.method
- Defined in main/requests/AbstractRequest.ts:178

`Protected` `Abstract` parseResponse

parseResponse(response: AxiosResponse<unknown>): T
Parses the response into a response object.
Parameters
- response: AxiosResponse<unknown>
  
  the parsed response.
Returns T
Inherited from AbstractRequest.parseResponse
- Defined in main/requests/AbstractRequest.ts:164

`Protected` `Abstract` url

url(): string
Gets the url for the request.

Returns
the url for the request.

Returns string
Inherited from AbstractRequest.url
- Defined in main/requests/AbstractRequest.ts:171

withApiVersion

withApiVersion(apiVersion: undefined | ApiVersion): AbstractGetMediaRequest<T>
Sets the API version that the request will use.

Returns
this request, for use in chain invocation.
Parameters
- apiVersion: undefined | ApiVersion
  
  the API version to use.
Returns AbstractGetMediaRequest<T>
Inherited from AbstractRequest.withApiVersion
- Defined in main/requests/AbstractRequest.ts:154

withLimit

withLimit(limit: number): AbstractGetMediaRequest<T>
Adds the limit param to the request.

Returns
this request, for use in chain invocation.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns AbstractGetMediaRequest<T>
Inherited from AbstractRequest.withLimit
- Defined in main/requests/AbstractRequest.ts:142

withPaging

withPaging(pageOptionToken: PageOptionToken): AbstractGetMediaRequest<T>
Adds a paging param to the request.

Returns
this request, for use in chain invocation.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns AbstractGetMediaRequest<T>
Inherited from AbstractRequest.withPaging
- Defined in main/requests/AbstractRequest.ts:114

withRange

withRange(since: Date, until: Date): AbstractGetMediaRequest<T>
Adds the range params to the request.

Returns
this request, for use in chain invocation.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns AbstractGetMediaRequest<T>
Inherited from AbstractRequest.withRange
- Defined in main/requests/AbstractRequest.ts:129

Class AbstractGetMediaRequest<T>Abstract

Author

Since

Type Parameters

T extends AbstractResponse<unknown>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

T extends AbstractResponse<unknown, T>

Parameters

accessToken: string

Rest ...fields: MediaField[]

Returns AbstractGetMediaRequest<T>

Properties

Protected Optional apiVersion

Protected params

Methods

addLimit

Deprecated

Parameters

limit: number

Returns void

addPaging

Deprecated

Parameters

pageOptionToken: PageOptionToken

Returns void

addRange

Deprecated

Parameters

since: Date

until: Date

Returns void

config

Returns

Returns RequestConfig

execute

Returns

Returns Promise<T>

Protected method

Returns

Returns Method

Protected Abstract parseResponse

Parameters

response: AxiosResponse<unknown>

Returns T

Protected Abstract url

Returns

Returns string

withApiVersion

Returns

Parameters

apiVersion: undefined | ApiVersion

Returns AbstractGetMediaRequest<T>

withLimit

Returns

Parameters

limit: number

Returns AbstractGetMediaRequest<T>

withPaging

Returns

Parameters

pageOptionToken: PageOptionToken

Returns AbstractGetMediaRequest<T>

withRange

Returns

Parameters

since: Date

until: Date

Returns AbstractGetMediaRequest<T>

Settings

Member Visibility

Theme

Class AbstractGetMediaRequest<T>`Abstract`

`Protected` constructor

`Rest` ...fields: MediaField[]

`Protected` `Optional` apiVersion

`Protected` params

`Protected` method

`Protected` `Abstract` parseResponse

`Protected` `Abstract` url