FuseConfluenceSDK

@appfire/fuse-confluence / Exports / FuseConfluenceSDK

Class: FuseConfluenceSDK

Table of contents

Constructors

• constructor

Properties

• comments
• spaces
• users
• confluenceRestClient

Methods

• appendUrlParams
• findPageResourceByTitleInSpace
• getAppInfoResource
• getCacheableMacroResource
• getCommentResource
• getConversionResource
• getDecryptResource
• getGroupResource
• getMacroResources
• getPage
• getSpaceResources
• getTemplateResource
• getUserResource
• sendRequest

Constructors

constructor

• new FuseConfluenceSDK(confluenceRestClient?)

Parameters

Name	Type
confluenceRestClient?	ConfluenceRestClient

Defined in

index.ts:27

Properties

comments

• Readonly comments: CommentsResource

Defined in

index.ts:24

---

spaces

• Readonly spaces: SpacesResource

Defined in

index.ts:25

---

users

• Readonly users: UserResource

Defined in

index.ts:23

---

confluenceRestClient

▪ Static Private confluenceRestClient: undefined | ConfluenceRestClient

Defined in

index.ts:22

Methods

appendUrlParams

▸ appendUrlParams(url, urlParams): string | string[]

Parameters

Name	Type
url	string | string[]
urlParams	string

Returns

string | string[]

Defined in

index.ts:67

---

findPageResourceByTitleInSpace

▸ findPageResourceByTitleInSpace(spaceId, pageTitle): Promise<PageResource>

Parameters

Name	Type
spaceId	string
pageTitle	string

Returns

Promise<PageResource>

Defined in

index.ts:80

---

getAppInfoResource

▸ getAppInfoResource(): AppInfoResource

Returns

AppInfoResource

Defined in

index.ts:70

---

getCacheableMacroResource

▸ getCacheableMacroResource(): CacheableMacro

Returns

CacheableMacro

Defined in

index.ts:54

---

getCommentResource

▸ getCommentResource(): CommentsResource

Returns

CommentsResource

Defined in

index.ts:35

---

getConversionResource

▸ getConversionResource(): ConversionResource

Returns

ConversionResource

Defined in

index.ts:58

---

getDecryptResource

▸ getDecryptResource(): DecryptResource

Returns

DecryptResource

Defined in

index.ts:64

---

getGroupResource

▸ getGroupResource(): GroupResource

Returns

GroupResource

Defined in

index.ts:47

---

getMacroResources

▸ getMacroResources(): MacroResource

Returns

MacroResource

Defined in

index.ts:61

---

getPage

▸ getPage(pageId): PageResource

Parameters

Name	Type
pageId	string

Returns

PageResource

Defined in

index.ts:43

---

getSpaceResources

▸ getSpaceResources(): SpacesResource

Returns

SpacesResource

Defined in

index.ts:39

---

getTemplateResource

▸ getTemplateResource(): TemplateResource

Returns

TemplateResource

Defined in

index.ts:51

---

getUserResource

▸ getUserResource(): UserResource

Returns

UserResource

Defined in

index.ts:31

---

sendRequest

▸ Static sendRequest<T>(config): Promise<T>

Type parameters

Name
T

Parameters

Name	Type
config	HttpConfig

Returns

Promise<T>

Defined in

index.ts:73