dist¶

Interfaces¶

ForumCommunityClient¶

Methods¶

createReply()¶

createReply(input): Promise<ForumCommunityProviderResponse>;

Parameters¶

Parameter	Type
`input`	`ForumCreateReplyInput`

Returns¶

Promise\<ForumCommunityProviderResponse>

createTopic()¶

createTopic(input): Promise<ForumCommunityProviderResponse>;

Parameters¶

Parameter	Type
`input`	`ForumCreateTopicInput`

Returns¶

Promise\<ForumCommunityProviderResponse>

getCurrentUser()¶

getCurrentUser(): Promise<ForumCommunityProviderResponse>;

Returns¶

Promise\<ForumCommunityProviderResponse>

getPost()¶

getPost(postId): Promise<ForumCommunityProviderResponse>;

Parameters¶

Parameter	Type
`postId`	`number`

Returns¶

Promise\<ForumCommunityProviderResponse>

getTopic()¶

getTopic(topicId): Promise<ForumCommunityProviderResponse>;

Parameters¶

Parameter	Type
`topicId`	`number`

Returns¶

Promise\<ForumCommunityProviderResponse>

latest()¶

latest(): Promise<ForumCommunityProviderResponse>;

Returns¶

Promise\<ForumCommunityProviderResponse>

search()¶

search(input): Promise<ForumCommunityProviderResponse>;

Parameters¶

Parameter	Type
`input`	`ForumSearchInput`

Returns¶

Promise\<ForumCommunityProviderResponse>

ForumCommunityClientOptions¶

Extended by¶

ForumCommunityIntegrationOptions

Properties¶

apiKey?¶

optional apiKey?: string;

apiUsername?¶

optional apiUsername?: string;

baseUrl?¶

optional baseUrl?: string;

client?¶

optional client?: ForumCommunityClient;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

providerClient?¶

optional providerClient?: ForumCommunityClient;

retry?¶

optional retry?: number | ProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

ForumCommunityIntegrationOptions¶

Extends¶

ForumCommunityClientOptions

Properties¶

apiKey?¶

optional apiKey?: string;

Inherited from¶

ForumCommunityClientOptions.apiKey

apiUsername?¶

optional apiUsername?: string;

Inherited from¶

ForumCommunityClientOptions.apiUsername

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

ForumCommunityClientOptions.baseUrl

client?¶

optional client?: ForumCommunityClient;

Inherited from¶

ForumCommunityClientOptions.client

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

ForumCommunityClientOptions.fetch

providerClient?¶

optional providerClient?: ForumCommunityClient;

Inherited from¶

ForumCommunityClientOptions.providerClient

retry?¶

optional retry?: number | ProviderJsonRetryOptions;

Inherited from¶

ForumCommunityClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

ForumCommunityClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

ForumCommunityClientOptions.timeoutMs

unavailableReason?¶

optional unavailableReason?: string;

ForumCommunityJsonObject¶

Indexable¶

[key: string]: ForumCommunityProviderExtensionValue

ForumCommunityProviderExtensionFields¶

Extends¶

ForumCommunityJsonObject

Indexable¶

[key: string]: ForumCommunityProviderExtensionValue

ForumCommunityProviderResponse¶

Extends¶

ForumCommunityJsonObject

Indexable¶

[key: string]: ForumCommunityProviderExtensionValue

ForumCreateReplyInput¶

Properties¶

raw¶

raw: string;

replyToPostNumber?¶

optional replyToPostNumber?: number;

topicId¶

topicId: number;

ForumCreateTopicInput¶

Properties¶

archetype?¶

optional archetype?: string;

category?¶

optional category?: number;

createdAt?¶

optional createdAt?: string;

raw¶

raw: string;

tags?¶

optional tags?: string[];

title¶

title: string;

ForumCredentialStatusInput¶

Properties¶

apiKeyConfigured?¶

optional apiKeyConfigured?: boolean;

apiUsername?¶

optional apiUsername?: string;

baseUrl?¶

optional baseUrl?: string;

scopes?¶

optional scopes?: string[];

webhookSecretConfigured?¶

optional webhookSecretConfigured?: boolean;

ForumLiveCheckOptions¶

Properties¶

client?¶

optional client?: Pick<ForumCommunityClient, "getCurrentUser" | "latest">;

unavailableReason?¶

optional unavailableReason?: string;

ForumSearchInput¶

Properties¶

page?¶

optional page?: number;

query¶

query: string;

ForumWebhookPayload¶

Indexable¶

[key: string]: ForumCommunityProviderExtensionValue

Properties¶

event?¶

optional event?: string;

eventType?¶

optional eventType?: string;

post?¶

optional post?: ForumCommunityJsonObject;

topic?¶

optional topic?: ForumCommunityJsonObject;

user?¶

optional user?: ForumCommunityJsonObject;

ParseForumWebhookOperationInput¶

Properties¶

options?¶

optional options?: ParseForumWebhookOptions;

request¶

request: Request;

ParseForumWebhookOptions¶

Properties¶

rawBody?¶

optional rawBody?: string;

requireSignature?¶

optional requireSignature?: boolean;

secret?¶

optional secret?: string;

ProviderJsonRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

Type Aliases¶

ForumCommunityJsonPrimitive¶

type ForumCommunityJsonPrimitive = string | number | boolean | null;

ForumCommunityJsonValue¶

type ForumCommunityJsonValue =
  | ForumCommunityJsonPrimitive
  | ForumCommunityJsonObject
  | readonly ForumCommunityJsonValue[];

ForumCommunityProviderClient¶

type ForumCommunityProviderClient = ForumCommunityClient;

ForumCommunityProviderExtensionValue¶

type ForumCommunityProviderExtensionValue =
  | ForumCommunityJsonValue
  | object
  | undefined;

ForumCommunityProviderPayload¶

type ForumCommunityProviderPayload = ForumCommunityJsonObject | object;

ForumCommunityProviderQuery¶

type ForumCommunityProviderQuery = Record<string, ForumCommunityProviderExtensionValue>;

Functions¶

createForumCommunityClient()¶

function createForumCommunityClient(options?): ForumCommunityClient;

Parameters¶

Parameter	Type
`options?`	`ForumCommunityClientOptions`

Returns¶

ForumCommunityClient

createForumCommunityIntegration()¶

function createForumCommunityIntegration(options?): DefinedIntegration<never, unknown, never>;

Parameters¶

Parameter	Type
`options?`	`ForumCommunityIntegrationOptions`

Returns¶

DefinedIntegration\<never, unknown, never>

createForumCommunityLiveChecks()¶

function createForumCommunityLiveChecks(options?): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        id: number;
        username: string;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options?`	`ForumLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { id: number; username: string; }; }>; }[]

createForumCommunityUnavailableClient()¶

function createForumCommunityUnavailableClient(reason?): ForumCommunityClient;

Parameters¶

Parameter	Type
`reason?`	`string`

Returns¶

ForumCommunityClient

forumCommunityCredentialStatuses()¶

function forumCommunityCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`ForumCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

parseForumWebhook()¶

function parseForumWebhook(request, options?): Promise<ForumWebhookPayload>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseForumWebhookOptions`

Returns¶

Promise\<ForumWebhookPayload>

validateForumWebhookSignature()¶

function validateForumWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	{ `rawBody`: `string`; `secret`: `string`; `signature`: `string`; }
`input.rawBody`	`string`
`input.secret`	`string`
`input.signature`	`string`

Returns¶

boolean

References¶

forumCommunityProviderManifest¶

Re-exports forumCommunityProviderManifest