confluence.js

English

Русский

English

Русский

Appearance

Interface: Space ​

Defined in: src/v1/models/space.ts:15

Properties ​

_expandable ​

ts
_expandable: object;

Defined in: src/v1/models/space.ts:45

description? ​

ts
optional description?: string;

history? ​

ts
optional history?: string;

homepage? ​

ts
optional homepage?: string;

icon? ​

ts
optional icon?: string;

identifiers? ​

ts
optional identifiers?: string;

lookAndFeel? ​

ts
optional lookAndFeel?: string;

metadata? ​

ts
optional metadata?: string;

operations? ​

ts
optional operations?: string;

permissions? ​

ts
optional permissions?: string;

roles? ​

ts
optional roles?: string;

settings? ​

ts
optional settings?: string;

theme? ​

ts
optional theme?: string;

typeSettings? ​

ts
optional typeSettings?: string;
ts
_links: object;

Defined in: src/v1/models/space.ts:60

Index Signature ​

ts
[key: string]: unknown

base? ​

ts
optional base?: string;

Base URL of the Confluence site.

byOperation? ​

ts
optional byOperation?: string;

Link to the restrictions grouped by operation.

collection? ​

ts
optional collection?: string;

Link to the collection this entity belongs to.

context? ​

ts
optional context?: string;

Context path of the Confluence site.

download? ​

ts
optional download?: string;

Download link for the content.

editui? ​

ts
optional editui?: string;

Edit UI link of the content.

edituiv2? ​

ts
optional edituiv2?: string;

Edit UI (v2 editor) link of the content.

next? ​

ts
optional next?: string;

Relative URL of the next page of results.

prev? ​

ts
optional prev?: string;

Relative URL of the previous page of results.

self? ​

ts
optional self?: string;

Canonical link to this entity.

tinyui? ​

ts
optional tinyui?: string;

Short web UI link of the content.

webui? ​

ts
optional webui?: string;

Web UI link of the content.

alias? ​

ts
optional alias?: string;

Defined in: src/v1/models/space.ts:18

ari? ​

ts
optional ari?: string;

Defined in: src/v1/models/space.ts:61

description? ​

ts
optional description?: object;

Defined in: src/v1/models/space.ts:21

_expandable? ​

ts
optional _expandable?: object;
_expandable.plain? ​
ts
optional plain?: string;
_expandable.view? ​
ts
optional view?: string;

plain? ​

ts
optional plain?: object;
Index Signature ​
ts
[key: string]: unknown
plain.embeddedContent ​
ts
embeddedContent: Record<string, any>[];
plain.representation ​
ts
representation: "view" | string & object | "plain";
plain.value ​
ts
value: string;

view? ​

ts
optional view?: object;
Index Signature ​
ts
[key: string]: unknown
view.embeddedContent ​
ts
embeddedContent: Record<string, any>[];
view.representation ​
ts
representation: "view" | string & object | "plain";
view.value ​
ts
value: string;

history? ​

ts
optional history?: object;

Defined in: src/v1/models/space.ts:41

createdBy? ​

ts
optional createdBy?: User;

createdDate ​

ts
createdDate: Date;

homepage? ​

ts
optional homepage?: Content;

Defined in: src/v1/models/space.ts:29

icon? ​

ts
optional icon?: object;

Defined in: src/v1/models/space.ts:20

Index Signature ​

ts
[key: string]: unknown

height ​

ts
height: number;

isDefault ​

ts
isDefault: boolean;

path ​

ts
path: string;

width ​

ts
width: number;

id? ​

ts
optional id?: number;

Defined in: src/v1/models/space.ts:16

key ​

ts
key: string;

Defined in: src/v1/models/space.ts:17

lookAndFeel? ​

ts
optional lookAndFeel?: object;

Defined in: src/v1/models/space.ts:40

Index Signature ​

ts
[key: string]: unknown

bordersAndDividers ​

ts
bordersAndDividers: object;
Index Signature ​
ts
[key: string]: unknown
bordersAndDividers.color ​
ts
color: string;

content ​

ts
content: object = ContentLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
content.body? ​
ts
optional body?: object;
Index Signature ​
ts
[key: string]: unknown
content.body.background ​
ts
background: string;
content.body.backgroundAttachment? ​
ts
optional backgroundAttachment?: string | null;
content.body.backgroundBlendMode? ​
ts
optional backgroundBlendMode?: string | null;
content.body.backgroundClip? ​
ts
optional backgroundClip?: string | null;
content.body.backgroundColor ​
ts
backgroundColor: string | null;
content.body.backgroundImage ​
ts
backgroundImage: string | null;
content.body.backgroundOrigin? ​
ts
optional backgroundOrigin?: string | null;
content.body.backgroundPosition? ​
ts
optional backgroundPosition?: string | null;
content.body.backgroundRepeat? ​
ts
optional backgroundRepeat?: string | null;
content.body.backgroundSize ​
ts
backgroundSize: string | null;
content.body.borderRadius ​
ts
borderRadius: string;
content.body.padding ​
ts
padding: string;
content.container? ​
ts
optional container?: object;
Index Signature ​
ts
[key: string]: unknown
content.container.background ​
ts
background: string;
content.container.backgroundAttachment? ​
ts
optional backgroundAttachment?: string | null;
content.container.backgroundBlendMode? ​
ts
optional backgroundBlendMode?: string | null;
content.container.backgroundClip? ​
ts
optional backgroundClip?: string | null;
content.container.backgroundColor ​
ts
backgroundColor: string | null;
content.container.backgroundImage ​
ts
backgroundImage: string | null;
content.container.backgroundOrigin? ​
ts
optional backgroundOrigin?: string | null;
content.container.backgroundPosition? ​
ts
optional backgroundPosition?: string | null;
content.container.backgroundRepeat? ​
ts
optional backgroundRepeat?: string | null;
content.container.backgroundSize ​
ts
backgroundSize: string | null;
content.container.borderRadius ​
ts
borderRadius: string;
content.container.padding ​
ts
padding: string;
content.header? ​
ts
optional header?: object;
Index Signature ​
ts
[key: string]: unknown
content.header.background ​
ts
background: string;
content.header.backgroundAttachment? ​
ts
optional backgroundAttachment?: string | null;
content.header.backgroundBlendMode? ​
ts
optional backgroundBlendMode?: string | null;
content.header.backgroundClip? ​
ts
optional backgroundClip?: string | null;
content.header.backgroundColor ​
ts
backgroundColor: string | null;
content.header.backgroundImage ​
ts
backgroundImage: string | null;
content.header.backgroundOrigin? ​
ts
optional backgroundOrigin?: string | null;
content.header.backgroundPosition? ​
ts
optional backgroundPosition?: string | null;
content.header.backgroundRepeat? ​
ts
optional backgroundRepeat?: string | null;
content.header.backgroundSize ​
ts
backgroundSize: string | null;
content.header.borderRadius ​
ts
borderRadius: string;
content.header.padding ​
ts
padding: string;
content.screen? ​
ts
optional screen?: object;
Index Signature ​
ts
[key: string]: unknown
content.screen.background ​
ts
background: string;
content.screen.backgroundAttachment? ​
ts
optional backgroundAttachment?: string | null;
content.screen.backgroundBlendMode? ​
ts
optional backgroundBlendMode?: string | null;
content.screen.backgroundClip? ​
ts
optional backgroundClip?: string | null;
content.screen.backgroundColor? ​
ts
optional backgroundColor?: string | null;
content.screen.backgroundImage? ​
ts
optional backgroundImage?: string | null;
content.screen.backgroundOrigin? ​
ts
optional backgroundOrigin?: string | null;
content.screen.backgroundPosition? ​
ts
optional backgroundPosition?: string | null;
content.screen.backgroundRepeat? ​
ts
optional backgroundRepeat?: string | null;
content.screen.backgroundSize? ​
ts
optional backgroundSize?: string | null;
content.screen.gutterBottom? ​
ts
optional gutterBottom?: string | null;
content.screen.gutterLeft? ​
ts
optional gutterLeft?: string | null;
content.screen.gutterRight? ​
ts
optional gutterRight?: string | null;
content.screen.gutterTop? ​
ts
optional gutterTop?: string | null;
content.screen.layer? ​
ts
optional layer?: 
  | {
[key: string]: unknown;
  height?: string;
  width?: string;
}
  | null;
ts
header: object = HeaderLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
header.backgroundColor ​
ts
backgroundColor: string;
header.button ​
ts
button: object = ButtonLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
header.button.backgroundColor ​
ts
backgroundColor: string;
header.button.color ​
ts
color: string;
header.primaryNavigation ​
ts
primaryNavigation: object = NavigationLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
header.primaryNavigation.color ​
ts
color: string;
header.primaryNavigation.highlightColor? ​
ts
optional highlightColor?: string | null;
header.primaryNavigation.hoverOrFocus ​
ts
hoverOrFocus: object;
Index Signature ​
ts
[key: string]: unknown
header.primaryNavigation.hoverOrFocus.backgroundColor ​
ts
backgroundColor: string;
header.primaryNavigation.hoverOrFocus.color ​
ts
color: string;
ts
search: object = SearchFieldLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
header.search.backgroundColor ​
ts
backgroundColor: string;
header.search.color ​
ts
color: string;
header.secondaryNavigation ​
ts
secondaryNavigation: object = NavigationLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
header.secondaryNavigation.color ​
ts
color: string;
header.secondaryNavigation.highlightColor? ​
ts
optional highlightColor?: string | null;
header.secondaryNavigation.hoverOrFocus ​
ts
hoverOrFocus: object;
Index Signature ​
ts
[key: string]: unknown
header.secondaryNavigation.hoverOrFocus.backgroundColor ​
ts
backgroundColor: string;
header.secondaryNavigation.hoverOrFocus.color ​
ts
color: string;

headings ​

ts
headings: object;
Index Signature ​
ts
[key: string]: unknown
headings.color ​
ts
color: string;

horizontalHeader? ​

ts
optional horizontalHeader?: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.backgroundColor ​
ts
backgroundColor: string;
horizontalHeader.button? ​
ts
optional button?: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.button.backgroundColor ​
ts
backgroundColor: string;
horizontalHeader.button.color ​
ts
color: string;
horizontalHeader.primaryNavigation ​
ts
primaryNavigation: object = TopNavigationLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.primaryNavigation.color? ​
ts
optional color?: string | null;
horizontalHeader.primaryNavigation.highlightColor ​
ts
highlightColor: string;
horizontalHeader.primaryNavigation.hoverOrFocus? ​
ts
optional hoverOrFocus?: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.primaryNavigation.hoverOrFocus.backgroundColor? ​
ts
optional backgroundColor?: string;
horizontalHeader.primaryNavigation.hoverOrFocus.color? ​
ts
optional color?: string;
ts
optional search?: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.search.backgroundColor ​
ts
backgroundColor: string;
horizontalHeader.search.color ​
ts
color: string;
horizontalHeader.secondaryNavigation? ​
ts
optional secondaryNavigation?: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.secondaryNavigation.color ​
ts
color: string;
horizontalHeader.secondaryNavigation.highlightColor? ​
ts
optional highlightColor?: string | null;
horizontalHeader.secondaryNavigation.hoverOrFocus ​
ts
hoverOrFocus: object;
Index Signature ​
ts
[key: string]: unknown
horizontalHeader.secondaryNavigation.hoverOrFocus.backgroundColor ​
ts
backgroundColor: string;
horizontalHeader.secondaryNavigation.hoverOrFocus.color ​
ts
color: string;
ts
links: object;
Index Signature ​
ts
[key: string]: unknown
ts
color: string;
ts
menus: object = MenusLookAndFeelSchema;
Index Signature ​
ts
[key: string]: unknown
ts
color: string;
ts
hoverOrFocus: object;
Index Signature ​
ts
[key: string]: unknown
ts
backgroundColor: string;

spaceReference? ​

ts
optional spaceReference?: Record<string, any> | null;

metadata? ​

ts
optional metadata?: object;

Defined in: src/v1/models/space.ts:31

_expandable? ​

ts
optional _expandable?: Record<string, unknown>;

labels? ​

ts
optional labels?: object;
Index Signature ​
ts
[key: string]: unknown
ts
optional _links?: object;
Index Signature ​
ts
[key: string]: unknown
ts
optional base?: string;

Base URL of the Confluence site.

ts
optional byOperation?: string;

Link to the restrictions grouped by operation.

ts
optional collection?: string;

Link to the collection this entity belongs to.

ts
optional context?: string;

Context path of the Confluence site.

ts
optional download?: string;

Download link for the content.

ts
optional editui?: string;

Edit UI link of the content.

ts
optional edituiv2?: string;

Edit UI (v2 editor) link of the content.

ts
optional next?: string;

Relative URL of the next page of results.

ts
optional prev?: string;

Relative URL of the previous page of results.

ts
optional self?: string;

Canonical link to this entity.

ts
optional tinyui?: string;

Short web UI link of the content.

ts
optional webui?: string;

Web UI link of the content.

labels.limit? ​
ts
optional limit?: number;
labels.results ​
ts
results: object[];
Index Signature ​
ts
[key: string]: unknown
labels.size ​
ts
size: number;
labels.start? ​
ts
optional start?: number;

name ​

ts
name: string;

Defined in: src/v1/models/space.ts:19

operations? ​

ts
optional operations?: object[];

Defined in: src/v1/models/space.ts:35

Index Signature ​

ts
[key: string]: unknown

operation ​

ts
operation: string;

The operation itself.

targetType ​

ts
targetType: string;

The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment

  • Attachment - space

permissions? ​

ts
optional permissions?: SpacePermission[];

Defined in: src/v1/models/space.ts:36

settings? ​

ts
optional settings?: object;

Defined in: src/v1/models/space.ts:38

Index Signature ​

ts
[key: string]: unknown
ts
_links: object = GenericLinksSchema;
Index Signature ​
ts
[key: string]: unknown
ts
optional base?: string;

Base URL of the Confluence site.

ts
optional byOperation?: string;

Link to the restrictions grouped by operation.

ts
optional collection?: string;

Link to the collection this entity belongs to.

ts
optional context?: string;

Context path of the Confluence site.

ts
optional download?: string;

Download link for the content.

ts
optional editui?: string;

Edit UI link of the content.

ts
optional edituiv2?: string;

Edit UI (v2 editor) link of the content.

ts
optional next?: string;

Relative URL of the next page of results.

ts
optional prev?: string;

Relative URL of the previous page of results.

ts
optional self?: string;

Canonical link to this entity.

ts
optional tinyui?: string;

Short web UI link of the content.

ts
optional webui?: string;

Web UI link of the content.

contentMode? ​

ts
optional contentMode?: "standard" | "compact" | string & object | null;

The content rendering mode for the space. Controls spacing and typography in the editor and renderer. Valid values are "standard" and "compact". When set to "compact", content is rendered more densely with smaller spacing and typography.

editor? ​

ts
optional editor?: object;
Index Signature ​
ts
[key: string]: unknown
editor.blogpost ​
ts
blogpost: string;
editor.default ​
ts
default: string;
editor.page ​
ts
page: string;

routeOverrideEnabled ​

ts
routeOverrideEnabled: boolean;

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

spaceKey? ​

ts
optional spaceKey?: string;

status ​

ts
status: string;

Defined in: src/v1/models/space.ts:37

theme? ​

ts
optional theme?: object;

Defined in: src/v1/models/space.ts:39

Index Signature ​

ts
[key: string]: unknown
ts
optional _links?: object;
Index Signature ​
ts
[key: string]: unknown
ts
optional base?: string;

Base URL of the Confluence site.

ts
optional byOperation?: string;

Link to the restrictions grouped by operation.

ts
optional collection?: string;

Link to the collection this entity belongs to.

ts
optional context?: string;

Context path of the Confluence site.

ts
optional download?: string;

Download link for the content.

ts
optional editui?: string;

Edit UI link of the content.

ts
optional edituiv2?: string;

Edit UI (v2 editor) link of the content.

ts
optional next?: string;

Relative URL of the next page of results.

ts
optional prev?: string;

Relative URL of the previous page of results.

ts
optional self?: string;

Canonical link to this entity.

ts
optional tinyui?: string;

Short web UI link of the content.

ts
optional webui?: string;

Web UI link of the content.

description? ​

ts
optional description?: string;

icon? ​

ts
optional icon?: object;
Index Signature ​
ts
[key: string]: unknown
icon.height ​
ts
height: number;
icon.isDefault ​
ts
isDefault: boolean;
icon.path ​
ts
path: string;
icon.width ​
ts
width: number;

name? ​

ts
optional name?: string;

themeKey ​

ts
themeKey: string;

type ​

ts
type: string;

Defined in: src/v1/models/space.ts:30