Class ConfluenceClient

Hierarchy (view full)

BaseClient
- ConfluenceClient

Constructors

constructor

new ConfluenceClient(config): ConfluenceClient
Parameters
- config: Config
Returns ConfluenceClient
Overrides BaseClient.constructor
- Defined in clients/confluenceClient.ts:39

Properties

`Private` #instance

#instance: undefined | AxiosInstance

analytics

analytics: Analytics = ...

audit

audit: Api.Audit = ...

`Protected` `Readonly` config

config: Config

content

content: Api.Content = ...

contentAttachments

contentAttachments: ContentAttachments = ...

contentBody

contentBody: Api.ContentBody = ...

contentChildrenAndDescendants

contentChildrenAndDescendants: ContentChildrenAndDescendants = ...

contentComments

contentComments: ContentComments = ...

contentContentState

contentContentState: ContentContentState = ...

contentLabels

contentLabels: ContentLabels = ...

contentMacroBody

contentMacroBody: ContentMacroBody = ...

contentPermissions

contentPermissions: ContentPermissions = ...

contentProperties

contentProperties: ContentProperties = ...

contentRestrictions

contentRestrictions: ContentRestrictions = ...

contentStates

contentStates: ContentStates = ...

contentVersions

contentVersions: ContentVersions = ...

contentWatches

contentWatches: ContentWatches = ...

dynamicModules

dynamicModules: DynamicModules = ...

experimental

experimental: Experimental = ...

group

group: Api.Group = ...

inlineTasks

inlineTasks: InlineTasks = ...

labelInfo

labelInfo: LabelInfo = ...

longRunningTask

longRunningTask: LongRunningTask = ...

relation

relation: Api.Relation = ...

search

search: Api.Search = ...

settings

settings: Settings = ...

space

space: Api.Space = ...

spacePermissions

spacePermissions: SpacePermissions = ...

spaceProperties

spaceProperties: SpaceProperties = ...

spaceSettings

spaceSettings: Api.SpaceSettings = ...

template

template: Template = ...

themes

themes: Themes = ...

users

users: Users = ...

Accessors

`Private` instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from BaseClient.instance
- Defined in clients/baseClient.ts:66

Methods

`Protected` encode

encode(value): string
Parameters
- value: string
Returns string
Inherited from BaseClient.encode
- Defined in clients/baseClient.ts:50

`Protected` paramSerializer

paramSerializer(parameters): string
Parameters
- parameters: Record<string, any>
Returns string
Inherited from BaseClient.paramSerializer
- Defined in clients/baseClient.ts:18

`Protected` removeUndefinedProperties

removeUndefinedProperties(obj): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
Inherited from BaseClient.removeUndefinedProperties
- Defined in clients/baseClient.ts:60

sendRequest

sendRequest<T>(requestConfig, callback, telemetryData?): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
- Optional telemetryData: any
Returns Promise<T>
Inherited from BaseClient.sendRequest
- Defined in clients/baseClient.ts:86
sendRequest<T>(requestConfig, callback, telemetryData?): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
- Optional telemetryData: any
Returns Promise<void>
Inherited from BaseClient.sendRequest
- Defined in clients/baseClient.ts:87

Generated using TypeDoc v0.25.12