Class AbstractGetPageInsightsRequest<T, R>`Abstract`

An abstract class to represent Page Insights Get Requests.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.2.0

Type Parameters

T extends DayMetric | WeekAndMonthMetric | LifetimeMetric

the type of the metrics of the request.
R extends AbstractGetInsightsResponse<AbstractMetric<unknown>>

the type of the response.

Hierarchy

AbstractRequest<R>
- AbstractGetPageInsightsRequest
  - AbstractGetPageTimedInsightsRequest
  - GetPageLifetimeInsightsRequest

Index

Constructors

`Protected` constructor

new AbstractGetPageInsightsRequest<T, R>(accessToken: string, pageId: string, metrics: Set<T>): AbstractGetPageInsightsRequest<T, R>
The constructor.
Type Parameters
- T extends DayMetric | WeekAndMonthMetric | LifetimeMetric
- R extends AbstractGetInsightsResponse<AbstractMetric<unknown>, R>
Parameters
- accessToken: string
  
  the access token.
- pageId: string
  
  the page ID.
- metrics: Set<T>
  
  the metrics definitions.
Returns AbstractGetPageInsightsRequest<T, R>
Overrides AbstractRequest.constructor
- Defined in main/requests/page/insights/AbstractGetPageInsightsRequest.ts:31

Properties

`Protected` `Optional` apiVersion

apiVersion?: ApiVersion

The API Version.

`Private` `Readonly` pageId

pageId: string

The id of the page.

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

Returns
the promise of a parsed response.

Returns Promise<R>
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>): R
Parses the response into a response object.
Parameters
- response: AxiosResponse<unknown>
  
  the parsed response.
Returns R
Inherited from AbstractRequest.parseResponse
- Defined in main/requests/AbstractRequest.ts:164

`Protected` `Abstract` period

period(): MetricPeriod
Gets the metric period.

Returns
the metric period.

Returns MetricPeriod
- Defined in main/requests/page/insights/AbstractGetPageInsightsRequest.ts:50

`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/insights/AbstractGetPageInsightsRequest.ts:41

withApiVersion

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

withLimit

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

withPaging

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

withRange

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

Class AbstractGetPageInsightsRequest<T, R>Abstract

Author

Since

Type Parameters

T extends DayMetric | WeekAndMonthMetric | LifetimeMetric

R extends AbstractGetInsightsResponse<AbstractMetric<unknown>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

T extends DayMetric | WeekAndMonthMetric | LifetimeMetric

R extends AbstractGetInsightsResponse<AbstractMetric<unknown>, R>

Parameters

accessToken: string

pageId: string

metrics: Set<T>

Returns AbstractGetPageInsightsRequest<T, R>

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

Protected method

Returns

Returns Method

Protected Abstract parseResponse

Parameters

response: AxiosResponse<unknown>

Returns R

Protected Abstract period

Returns

Returns MetricPeriod

Protected url

Returns

Returns string

withApiVersion

Returns

Parameters

apiVersion: undefined | ApiVersion

Returns AbstractGetPageInsightsRequest<T, R>

withLimit

Returns

Parameters

limit: number

Returns AbstractGetPageInsightsRequest<T, R>

withPaging

Returns

Parameters

pageOptionToken: PageOptionToken

Returns AbstractGetPageInsightsRequest<T, R>

withRange

Returns

Parameters

since: Date

Class AbstractGetPageInsightsRequest<T, R>`Abstract`

`Protected` constructor

`Protected` `Optional` apiVersion

`Private` `Readonly` pageId

`Protected` params

`Protected` method

`Protected` `Abstract` parseResponse

`Protected` `Abstract` period

`Protected` url