wb.links

WorkbookLinks

11 methods

→ readonly PersistedWorkbookLinkRecord[]

list(): readonly PersistedWorkbookLinkRecord[];

→ PersistedWorkbookLinkRecord | null

get(linkId: LinkId): PersistedWorkbookLinkRecord | null;

Parameter	Type	Required
linkId	LinkId	required

→ PersistedWorkbookLinkRecord

add(input: CreateWorkbookLinkInput): PersistedWorkbookLinkRecord;

Parameter	Type	Required
input	CreateWorkbookLinkInput	required

→ PersistedWorkbookLinkRecord

create(input: CreateWorkbookLinkInput): PersistedWorkbookLinkRecord;

Parameter	Type	Required
input	CreateWorkbookLinkInput	required

→ PersistedWorkbookLinkRecord

retarget(linkId: LinkId, input: RetargetWorkbookLinkInput): PersistedWorkbookLinkRecord;

Parameter	Type	Required
linkId	LinkId	required
input	RetargetWorkbookLinkInput	required

→ PersistedWorkbookLinkRecord

update(linkId: LinkId, input: UpdateWorkbookLinkInput): PersistedWorkbookLinkRecord;

Parameter	Type	Required
linkId	LinkId	required
input	UpdateWorkbookLinkInput	required

→ boolean

break(linkId: LinkId, options?: BreakWorkbookLinkOptions): boolean;

Parameter	Type	Required
linkId	LinkId	required
options	BreakWorkbookLinkOptions	optional

→ boolean

delete(linkId: LinkId): boolean;

Parameter	Type	Required
linkId	LinkId	required

→ LinkStatusView

getStatus(linkId: LinkId): LinkStatusView;

Parameter	Type	Required
linkId	LinkId	required

→ Promise<LinkStatusView>

refresh(linkId: LinkId): Promise<LinkStatusView>;

Parameter	Type	Required
linkId	LinkId	required

→ () => void

watchStatus(linkId: LinkId, handler: (status: LinkStatusView) => void): () => void;

Parameter	Type	Required
linkId	LinkId	required
handler	(status: LinkStatusView) => void	required