Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 8 additions & 8 deletions docs/english/reference/oauth/classes/AuthorizationError.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: AuthorizationError

Defined in: [src/errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L40)
Defined in: [packages/oauth/src/errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L40)

## Extends

Expand All @@ -20,7 +20,7 @@ Defined in: [src/errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/m
new AuthorizationError(message, original?): AuthorizationError;
```

Defined in: [src/errors.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L45)
Defined in: [packages/oauth/src/errors.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L45)

#### Parameters

Expand Down Expand Up @@ -50,7 +50,7 @@ Error.constructor
code: ErrorCode = ErrorCode.AuthorizationError;
```

Defined in: [src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L41)
Defined in: [packages/oauth/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L41)

#### Implementation of

Expand Down Expand Up @@ -101,10 +101,10 @@ Error.name
### original

```ts
original: undefined | Error;
original: Error | undefined;
```

Defined in: [src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L43)
Defined in: [packages/oauth/src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L43)

***

Expand Down Expand Up @@ -134,7 +134,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: node\_modules/@types/node/globals.d.ts:162
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -160,7 +160,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/@types/node/globals.d.ts:146
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -234,7 +234,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/@types/node/globals.d.ts:150
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150

#### Parameters

Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/oauth/classes/ClearStateStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: ClearStateStore

Defined in: [src/state-stores/clear-state-store.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L8)
Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L8)

Generates state parameter value in the OAuth flow.
While the state parameter value works for the CSRF protection purpose,
Expand All @@ -21,7 +21,7 @@ it can transfer the given InstallURLOptions value to the Redirect URL handler
new ClearStateStore(stateSecret, stateExpirationSeconds): ClearStateStore;
```

Defined in: [src/state-stores/clear-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L13)
Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L13)

#### Parameters

Expand All @@ -45,7 +45,7 @@ Defined in: [src/state-stores/clear-state-store.ts:13](https://github.com/slacka
generateStateParam(installOptions, now): Promise<string>;
```

Defined in: [src/state-stores/clear-state-store.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L18)
Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L18)

Generates a valid state parameter value, which can be decoded as a StateObj object
by the verifyStateParam() method. This value may be stored on the server-side with expiration.
Expand Down Expand Up @@ -77,7 +77,7 @@ The InstallProvider verifies if this value is set in the installer's browser ses
verifyStateParam(now, state): Promise<InstallURLOptions>;
```

Defined in: [src/state-stores/clear-state-store.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L27)
Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L27)

Verifies the given state string value by trying to decode the value and
build the passed InstallURLOptions object from the data.
Expand Down
10 changes: 5 additions & 5 deletions docs/english/reference/oauth/classes/FileInstallationStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: FileInstallationStore

Defined in: [src/installation-stores/file-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L14)
Defined in: [packages/oauth/src/installation-stores/file-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L14)

## Implements

Expand All @@ -16,7 +16,7 @@ Defined in: [src/installation-stores/file-store.ts:14](https://github.com/slacka
new FileInstallationStore(__namedParameters): FileInstallationStore;
```

Defined in: [src/installation-stores/file-store.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L19)
Defined in: [packages/oauth/src/installation-stores/file-store.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L19)

#### Parameters

Expand All @@ -36,7 +36,7 @@ Defined in: [src/installation-stores/file-store.ts:19](https://github.com/slacka
deleteInstallation(query, logger?): Promise<void>;
```

Defined in: [src/installation-stores/file-store.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L99)
Defined in: [packages/oauth/src/installation-stores/file-store.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L99)

#### Parameters

Expand Down Expand Up @@ -64,7 +64,7 @@ Defined in: [src/installation-stores/file-store.ts:99](https://github.com/slacka
fetchInstallation(query, logger?): Promise<Installation<"v1" | "v2", boolean>>;
```

Defined in: [src/installation-stores/file-store.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L61)
Defined in: [packages/oauth/src/installation-stores/file-store.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L61)

#### Parameters

Expand Down Expand Up @@ -92,7 +92,7 @@ Defined in: [src/installation-stores/file-store.ts:61](https://github.com/slacka
storeInstallation(installation, logger?): Promise<void>;
```

Defined in: [src/installation-stores/file-store.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L28)
Defined in: [packages/oauth/src/installation-stores/file-store.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L28)

#### Parameters

Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/oauth/classes/FileStateStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: FileStateStore

Defined in: [src/state-stores/file-state-store.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L17)
Defined in: [packages/oauth/src/state-stores/file-state-store.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L17)

Generates state parameter value in the OAuth flow.
While the state parameter value works for the CSRF protection purpose,
Expand All @@ -21,7 +21,7 @@ it can transfer the given InstallURLOptions value to the Redirect URL handler
new FileStateStore(args): FileStateStore;
```

Defined in: [src/state-stores/file-state-store.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L24)
Defined in: [packages/oauth/src/state-stores/file-state-store.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L24)

#### Parameters

Expand All @@ -41,7 +41,7 @@ Defined in: [src/state-stores/file-state-store.ts:24](https://github.com/slackap
generateStateParam(installOptions, now): Promise<string>;
```

Defined in: [src/state-stores/file-state-store.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L30)
Defined in: [packages/oauth/src/state-stores/file-state-store.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L30)

Generates a valid state parameter value, which can be decoded as a StateObj object
by the verifyStateParam() method. This value may be stored on the server-side with expiration.
Expand Down Expand Up @@ -73,7 +73,7 @@ The InstallProvider verifies if this value is set in the installer's browser ses
verifyStateParam(now, state): Promise<InstallURLOptions>;
```

Defined in: [src/state-stores/file-state-store.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L41)
Defined in: [packages/oauth/src/state-stores/file-state-store.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L41)

Verifies the given state string value by trying to decode the value and
build the passed InstallURLOptions object from the data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: GenerateInstallUrlError

Defined in: [src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L22)
Defined in: [packages/oauth/src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L22)

## Extends

Expand Down Expand Up @@ -46,7 +46,7 @@ Error.constructor
code: ErrorCode = ErrorCode.GenerateInstallUrlError;
```

Defined in: [src/errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L23)
Defined in: [packages/oauth/src/errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L23)

#### Implementation of

Expand Down Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: node\_modules/@types/node/globals.d.ts:162
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/@types/node/globals.d.ts:146
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/@types/node/globals.d.ts:150
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150

#### Parameters

Expand Down
16 changes: 8 additions & 8 deletions docs/english/reference/oauth/classes/InstallProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: InstallProvider

Defined in: [src/install-provider.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L32)
Defined in: [packages/oauth/src/install-provider.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L32)

InstallProvider Class. Refer to InsallProviderOptions interface for the details of constructor arguments.

Expand All @@ -14,7 +14,7 @@ InstallProvider Class. Refer to InsallProviderOptions interface for the details
new InstallProvider(__namedParameters): InstallProvider;
```

Defined in: [src/install-provider.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L87)
Defined in: [packages/oauth/src/install-provider.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L87)

#### Parameters

Expand All @@ -34,7 +34,7 @@ Defined in: [src/install-provider.ts:87](https://github.com/slackapi/node-slack-
installationStore: InstallationStore;
```

Defined in: [src/install-provider.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L38)
Defined in: [packages/oauth/src/install-provider.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L38)

***

Expand All @@ -44,7 +44,7 @@ Defined in: [src/install-provider.ts:38](https://github.com/slackapi/node-slack-
optional stateStore: StateStore;
```

Defined in: [src/install-provider.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L35)
Defined in: [packages/oauth/src/install-provider.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L35)

## Methods

Expand All @@ -54,7 +54,7 @@ Defined in: [src/install-provider.ts:35](https://github.com/slackapi/node-slack-
authorize(source): Promise<AuthorizeResult>;
```

Defined in: [src/install-provider.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L177)
Defined in: [packages/oauth/src/install-provider.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L177)

Fetches data from the installationStore

Expand All @@ -79,7 +79,7 @@ generateInstallUrl(
state?): Promise<string>;
```

Defined in: [src/install-provider.ts:415](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L415)
Defined in: [packages/oauth/src/install-provider.ts:415](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L415)

Returns a URL that is suitable for including in an Add to Slack button
Uses stateStore to generate a value for the state query param.
Expand Down Expand Up @@ -114,7 +114,7 @@ handleCallback(
installOptions?): Promise<void>;
```

Defined in: [src/install-provider.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L485)
Defined in: [packages/oauth/src/install-provider.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L485)

This method handles the incoming request to the callback URL.
It can be used as a RequestListener in almost any HTTP server
Expand Down Expand Up @@ -158,7 +158,7 @@ handleInstallPath(
installOptions?): Promise<void>;
```

Defined in: [src/install-provider.ts:330](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L330)
Defined in: [packages/oauth/src/install-provider.ts:330](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L330)

Handles the install path (the default is /slack/install) requests from an app installer.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: InstallerInitializationError

Defined in: [src/errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L18)
Defined in: [packages/oauth/src/errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L18)

## Extends

Expand Down Expand Up @@ -46,7 +46,7 @@ Error.constructor
code: ErrorCode = ErrorCode.InstallerInitializationError;
```

Defined in: [src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L19)
Defined in: [packages/oauth/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L19)

#### Implementation of

Expand Down Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: node\_modules/@types/node/globals.d.ts:162
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/@types/node/globals.d.ts:146
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/@types/node/globals.d.ts:150
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150

#### Parameters

Expand Down
10 changes: 5 additions & 5 deletions docs/english/reference/oauth/classes/InvalidStateError.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Class: InvalidStateError

Defined in: [src/errors.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L28)
Defined in: [packages/oauth/src/errors.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L28)

## Extends

Expand Down Expand Up @@ -46,7 +46,7 @@ Error.constructor
code: ErrorCode = ErrorCode.InvalidStateError;
```

Defined in: [src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L29)
Defined in: [packages/oauth/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L29)

#### Implementation of

Expand Down Expand Up @@ -120,7 +120,7 @@ Error.stack
static stackTraceLimit: number;
```

Defined in: node\_modules/@types/node/globals.d.ts:162
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
Expand All @@ -146,7 +146,7 @@ Error.stackTraceLimit
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/@types/node/globals.d.ts:146
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
Expand Down Expand Up @@ -220,7 +220,7 @@ Error.captureStackTrace
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/@types/node/globals.d.ts:150
Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150

#### Parameters

Expand Down
Loading