Class PostMediaCommentRequest

A request that creates a comment on a media object.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.5.0

Hierarchy

AbstractMediaCommentsRequest<CreatedObjectIdResponse>
- PostMediaCommentRequest

Index

Constructors

Properties

apiVersion? params

Methods

addLimit addPaging addRange config execute method parseResponse url withApiVersion withLimit withPaging withRange

Constructors

constructor

new PostMediaCommentRequest(accessToken: string, mediaId: string, text: string): PostMediaCommentRequest
The constructor.
Parameters
- accessToken: string
  
  The access token.
- mediaId: string
  
  the id of the media object.
- text: string
  
  the text of the comment.
Returns PostMediaCommentRequest
Overrides AbstractMediaCommentsRequest.constructor
- Defined in main/requests/media/comments/PostMediaCommentRequest.ts:20

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 AbstractMediaCommentsRequest.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 AbstractMediaCommentsRequest.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 AbstractMediaCommentsRequest.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 AbstractMediaCommentsRequest.config
- Defined in main/requests/AbstractRequest.ts:50

execute

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

Returns
the promise of a parsed response.

Returns Promise<CreatedObjectIdResponse>
Inherited from AbstractMediaCommentsRequest.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
Overrides AbstractMediaCommentsRequest.method
- Defined in main/requests/media/comments/PostMediaCommentRequest.ts:35

`Protected` parseResponse

parseResponse(response: AxiosResponse<never>): CreatedObjectIdResponse
Parses the response into a response object.
Parameters
- response: AxiosResponse<never>
  
  the parsed response.
Returns CreatedObjectIdResponse
Overrides AbstractMediaCommentsRequest.parseResponse
- Defined in main/requests/media/comments/PostMediaCommentRequest.ts:28

`Protected` url

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

Returns
the url for the request.

Returns string
Inherited from AbstractMediaCommentsRequest.url
- Defined in main/requests/media/comments/AbstractMediaCommentsRequest.ts:30

withApiVersion

withApiVersion(apiVersion: undefined | ApiVersion): PostMediaCommentRequest
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 PostMediaCommentRequest
Inherited from AbstractMediaCommentsRequest.withApiVersion
- Defined in main/requests/AbstractRequest.ts:154

withLimit

withLimit(limit: number): PostMediaCommentRequest
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 PostMediaCommentRequest
Inherited from AbstractMediaCommentsRequest.withLimit
- Defined in main/requests/AbstractRequest.ts:142

withPaging

withPaging(pageOptionToken: PageOptionToken): PostMediaCommentRequest
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 PostMediaCommentRequest
Inherited from AbstractMediaCommentsRequest.withPaging
- Defined in main/requests/AbstractRequest.ts:114

withRange

withRange(since: Date, until: Date): PostMediaCommentRequest
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 PostMediaCommentRequest
Inherited from AbstractMediaCommentsRequest.withRange
- Defined in main/requests/AbstractRequest.ts:129

Generated using TypeDoc