Class GetPageRecentlySearchedHashtagsRequest

A request that gets the Recently Searched Hashtags of a user/page.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

1.3.0

Hierarchy

AbstractRequest<ManyIdsResponse>
- GetPageRecentlySearchedHashtagsRequest

Index

Constructors

constructor

new GetPageRecentlySearchedHashtagsRequest(accessToken: string, pageId: string): GetPageRecentlySearchedHashtagsRequest
The constructor
Parameters
- accessToken: string
  
  the access token.
- pageId: string
  
  the page id
Returns GetPageRecentlySearchedHashtagsRequest
Overrides AbstractRequest.constructor
- Defined in main/requests/page/recently_searched_hashtags/GetPageRecentlySearchedHashtagsRequest.ts:24

Properties

`Protected` `Optional` apiVersion

apiVersion?: ApiVersion

The API Version.

`Private` `Readonly` pageId

pageId: string

The page id.

`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<ManyIdsResponse>
Executes the requests and returns a promise of the parsed response.

Returns
the promise of a parsed response.

Returns Promise<ManyIdsResponse>
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` parseResponse

parseResponse(response: AxiosResponse<{
    data: {
        id: string;
    }[];
    paging: PagingData;
}>): ManyIdsResponse
Parses the response into a response object.
Parameters
- response: AxiosResponse<{
      data: {
          id: string;
      }[];
      paging: PagingData;
  }>
  
  the parsed response.
Returns ManyIdsResponse
Overrides AbstractRequest.parseResponse
- Defined in main/requests/page/recently_searched_hashtags/GetPageRecentlySearchedHashtagsRequest.ts:32

`Protected` url

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

Returns
the url for the request.

Returns string
Overrides AbstractRequest.url
- Defined in main/requests/page/recently_searched_hashtags/GetPageRecentlySearchedHashtagsRequest.ts:39

withApiVersion

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

withLimit

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

withPaging

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

withRange

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

Class GetPageRecentlySearchedHashtagsRequest

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

accessToken: string

pageId: string

Returns GetPageRecentlySearchedHashtagsRequest

Properties

Protected Optional apiVersion

Private Readonly pageId

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<ManyIdsResponse>

Protected method

Returns

Returns Method

Protected parseResponse

Parameters

response: AxiosResponse<{ data: { id: string; }[]; paging: PagingData; }>

Returns ManyIdsResponse

Protected url

Returns

Returns string

withApiVersion

Returns

Parameters

apiVersion: undefined | ApiVersion

Returns GetPageRecentlySearchedHashtagsRequest

withLimit

Returns

Parameters

limit: number

Returns GetPageRecentlySearchedHashtagsRequest

withPaging

Returns

Parameters

pageOptionToken: PageOptionToken

Returns GetPageRecentlySearchedHashtagsRequest

withRange

Returns

Parameters

since: Date

until: Date

Returns GetPageRecentlySearchedHashtagsRequest

Settings

Member Visibility

Theme

`Protected` `Optional` apiVersion

`Private` `Readonly` pageId

`Protected` params

`Protected` method

`Protected` parseResponse

response: AxiosResponse<{
data: {
id: string;
}[];
paging: PagingData;
}>

`Protected` url