@ibm-wch-sdk/inline-edit-api

Exposes framework independent APIs between the inline edit implementation and the inline edit host.

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Usage

Install the module via

npm install --save @ibm-wch-sdk/inline-edit-api

API

TBD

Changelog

Current

Added

• Initial version

@ibm-wch-sdk/inline-edit-api

Index

External modules

• "active.message"
• "add.content.done.message"
• "add.content.message"
• "approve.message"
• "close.inline.settings.modal.message"
• "close.palette.message"
• "create.channel.message"
• "highlight.message"
• "index"
• "link.finished.message"
• "link.message"
• "locale.message"
• "message"
• "open.config.settings.message"
• "open.editor.message"
• "open.image.editor.message"
• "open.layout.settings.message"
• "open.palette.message"
• "page.changed.message"
• "ready.message"
• "register.message"
• "resize.message"
• "save.completed.message"
• "save.failed.message"
• "save.message"
• "scroll.message"
• "transformed.text.finished.message"
• "transformed.text.message"
• "unlock.message"
• "wca.pzn.field.finished.message"
• "wca.pzn.field.message"
• "wch.config.message"
• "wch.info.message"

@ibm-wch-sdk/inline-edit-api > "active.message"

External module: "active.message"

Index

Interfaces

• InlineEditActiveMessage

Variables

• INLINE_EDIT_ACTIVE_EVENT

Functions

• isInlineEditActiveMessage

Variables

<Const> INLINE_EDIT_ACTIVE_EVENT

● INLINE_EDIT_ACTIVE_EVENT: "inlineedit.active" = "inlineedit.active"

Defined in active.message.ts:3

Functions

isInlineEditActiveMessage

▸ isInlineEditActiveMessage(aValue: any): boolean

Defined in active.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "add.content.done.message"

External module: "add.content.done.message"

Index

Interfaces

• InlineAddContentDoneMessage

Variables

• INLINE_EDIT_ADD_CONTENT_DONE

Functions

• inlineAddContentDoneMessage
• isInlineAddContentDoneMessage

Variables

<Const> INLINE_EDIT_ADD_CONTENT_DONE

● INLINE_EDIT_ADD_CONTENT_DONE: "inlineedit.add.content.done" = "inlineedit.add.content.done"

Defined in add.content.done.message.ts:3

Functions

inlineAddContentDoneMessage

▸ inlineAddContentDoneMessage(id: string, accessor: string, addedId: string): InlineAddContentDoneMessage

Defined in add.content.done.message.ts:32

Parameters:

| Name | Type | | ------ | ------ | | id | string | | accessor | string | | addedId | string |

Returns: InlineAddContentDoneMessage

isInlineAddContentDoneMessage

▸ isInlineAddContentDoneMessage(aValue: any): boolean

Defined in add.content.done.message.ts:45

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "add.content.message"

External module: "add.content.message"

Index

Enumerations

• ADD_CONTENT_MODE

Interfaces

• InlineAddContentMessage

Variables

• INLINE_EDIT_ADD_CONTENT

Functions

• inlineAddContentMessage
• isInlineAddContentMessage

Variables

<Const> INLINE_EDIT_ADD_CONTENT

● INLINE_EDIT_ADD_CONTENT: "inlineedit.add.content" = "inlineedit.add.content"

Defined in add.content.message.ts:3

Functions

inlineAddContentMessage

▸ inlineAddContentMessage(id: string, accessor: string, mode?: ADD_CONTENT_MODE): InlineAddContentMessage

Defined in add.content.message.ts:40

Create the message

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | id | string | content item id | | accessor | string | accessor to the item | | Optional mode | ADD_CONTENT_MODE | optionally the composition mode |

Returns: InlineAddContentMessage

isInlineAddContentMessage

▸ isInlineAddContentMessage(aValue: any): boolean

Defined in add.content.message.ts:59

Tests if the message is a valid 'AddContentMessage'

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aValue | any | some object |

Returns: boolean true if the message is valid

@ibm-wch-sdk/inline-edit-api > "approve.message"

External module: "approve.message"

Index

Interfaces

• InlineEditApproveMessage

Variables

• INLINE_EDIT_APPROVE_MESSAGE

Functions

• inlineEditApproveMessage
• isInlineEditApproveMessage

Variables

<Const> INLINE_EDIT_APPROVE_MESSAGE

● INLINE_EDIT_APPROVE_MESSAGE: "inlineedit.approve" = "inlineedit.approve"

Defined in approve.message.ts:3

Functions

inlineEditApproveMessage

▸ inlineEditApproveMessage(contentId: string, contentName: string): InlineEditApproveMessage

Defined in approve.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string |

Returns: InlineEditApproveMessage

isInlineEditApproveMessage

▸ isInlineEditApproveMessage(aValue: any): boolean

Defined in approve.message.ts:22

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "close.inline.settings.modal.message"

External module: "close.inline.settings.modal.message"

Index

Interfaces

• InlineEditCloseInlineEditModalMessage

Variables

• INLINE_EDIT_CLOSE_INLINE_EDIT_MODAL_MESSAGE

Functions

• inlineEditCloseInlineEditModalMessage
• isInlineEditCloseInlineEditModalMessage

Variables

<Const> INLINE_EDIT_CLOSE_INLINE_EDIT_MODAL_MESSAGE

● INLINE_EDIT_CLOSE_INLINE_EDIT_MODAL_MESSAGE: "inlineedit.closeInlineSettingsModal" = "inlineedit.closeInlineSettingsModal"

Defined in close.inline.settings.modal.message.ts:3

Functions

inlineEditCloseInlineEditModalMessage

▸ inlineEditCloseInlineEditModalMessage(): InlineEditCloseInlineEditModalMessage

Defined in close.inline.settings.modal.message.ts:11

Returns: InlineEditCloseInlineEditModalMessage

isInlineEditCloseInlineEditModalMessage

▸ isInlineEditCloseInlineEditModalMessage(aValue: any): boolean

Defined in close.inline.settings.modal.message.ts:17

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "close.palette.message"

External module: "close.palette.message"

Index

Interfaces

• InlineEditClosePaletteMessage

Variables

• INLINE_EDIT_CLOSE_PALETTE_MESSAGE

Functions

• inlineEditClosePaletteMessage
• isInlineEditClosePaletteMessage

Variables

<Const> INLINE_EDIT_CLOSE_PALETTE_MESSAGE

● INLINE_EDIT_CLOSE_PALETTE_MESSAGE: "inlineedit.closePalette" = "inlineedit.closePalette"

Defined in close.palette.message.ts:3

Functions

inlineEditClosePaletteMessage

▸ inlineEditClosePaletteMessage(): InlineEditClosePaletteMessage

Defined in close.palette.message.ts:9

Returns: InlineEditClosePaletteMessage

isInlineEditClosePaletteMessage

▸ isInlineEditClosePaletteMessage(aValue: any): boolean

Defined in close.palette.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "create.channel.message"

External module: "create.channel.message"

Index

Interfaces

• InlineEditCreateChannelMessage

Variables

• INLINE_EDIT_CREATE_CHANNEL

Functions

• inlineEditCreateChannelMessage
• isInlineEditCreateChannelMessage

Variables

<Const> INLINE_EDIT_CREATE_CHANNEL

● INLINE_EDIT_CREATE_CHANNEL: "inlineedit.create.channel" = "inlineedit.create.channel"

Defined in create.channel.message.ts:3

Functions

inlineEditCreateChannelMessage

▸ inlineEditCreateChannelMessage(): InlineEditCreateChannelMessage

Defined in create.channel.message.ts:9

Returns: InlineEditCreateChannelMessage

isInlineEditCreateChannelMessage

▸ isInlineEditCreateChannelMessage(aValue: any): boolean

Defined in create.channel.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "highlight.message"

External module: "highlight.message"

Index

Interfaces

• InlineEditHighlightMessage

Variables

• INLINE_EDIT_HIGHLIGHT_MESSAGE

Functions

• inlineEditHighlightMessage
• isInlineEditHighlightMessage

Variables

<Const> INLINE_EDIT_HIGHLIGHT_MESSAGE

● INLINE_EDIT_HIGHLIGHT_MESSAGE: "inlineedit.highlight" = "inlineedit.highlight"

Defined in highlight.message.ts:3

Functions

inlineEditHighlightMessage

▸ inlineEditHighlightMessage(contentId: string, contentName: string, element: Array<ElementData>, forceOpen: boolean): InlineEditHighlightMessage

Defined in highlight.message.ts:13

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string | | element | Array<ElementData> | | forceOpen | boolean |

Returns: InlineEditHighlightMessage

isInlineEditHighlightMessage

▸ isInlineEditHighlightMessage(aValue: any): boolean

Defined in highlight.message.ts:28

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "index"

External module: "index"

Index

@ibm-wch-sdk/inline-edit-api > "link.finished.message"

External module: "link.finished.message"

Index

Interfaces

• InlineEditLinkFinishedMessage

Variables

• INLINE_EDIT_LINK_FINISHED_MESSAGE

Functions

• inlineEditLinkFinishedMessage
• isInlineEditLinkFinishedMessage

Variables

<Const> INLINE_EDIT_LINK_FINISHED_MESSAGE

● INLINE_EDIT_LINK_FINISHED_MESSAGE: "inlineedit.link.finished" = "inlineedit.link.finished"

Defined in link.finished.message.ts:3

Functions

inlineEditLinkFinishedMessage

▸ inlineEditLinkFinishedMessage(): InlineEditLinkFinishedMessage

Defined in link.finished.message.ts:9

Returns: InlineEditLinkFinishedMessage

isInlineEditLinkFinishedMessage

▸ isInlineEditLinkFinishedMessage(aValue: any): boolean

Defined in link.finished.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "link.message"

External module: "link.message"

Index

Interfaces

• InlineEditLinkMessage

Variables

• INLINE_EDIT_LINK_MESSAGE

Functions

• inlineEditLinkMessage
• isInlineEditLinkMessage

Variables

<Const> INLINE_EDIT_LINK_MESSAGE

● INLINE_EDIT_LINK_MESSAGE: "inlineedit.link" = "inlineedit.link"

Defined in link.message.ts:3

Functions

inlineEditLinkMessage

▸ inlineEditLinkMessage(contentId: string, accessor: string, linkURL: string, linkText: string, linkDescription: string): InlineEditLinkMessage

Defined in link.message.ts:14

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | accessor | string | | linkURL | string | | linkText | string | | linkDescription | string |

Returns: InlineEditLinkMessage

isInlineEditLinkMessage

▸ isInlineEditLinkMessage(aValue: any): boolean

Defined in link.message.ts:31

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "locale.message"

External module: "locale.message"

Index

Interfaces

• InlineEditLocaleMessage

Variables

• INLINE_EDIT_LOCALE_MESSAGE

Functions

• inlineEditLocaleMessage
• isInlineEditLocaleMessage

Variables

<Const> INLINE_EDIT_LOCALE_MESSAGE

● INLINE_EDIT_LOCALE_MESSAGE: "inlineedit.locale" = "inlineedit.locale"

Defined in locale.message.ts:1

Functions

inlineEditLocaleMessage

▸ inlineEditLocaleMessage(aLocale?: string): InlineEditLocaleMessage

Defined in locale.message.ts:8

Parameters:

| Name | Type | | ------ | ------ | | Optional aLocale | string |

Returns: InlineEditLocaleMessage

isInlineEditLocaleMessage

▸ isInlineEditLocaleMessage(aValue: any): boolean

Defined in locale.message.ts:20

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "message"

External module: "message"

Index

Interfaces

• ElementData
• InlineEditMessage

Functions

• isInlineEditMessage

Functions

isInlineEditMessage

▸ isInlineEditMessage(aValue: any): boolean

Defined in message.ts:20

Tests if a value is a valid inline edit message

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aValue | any | any value |

Returns: boolean true if the value is a valid message

@ibm-wch-sdk/inline-edit-api > "open.config.settings.message"

External module: "open.config.settings.message"

Index

Interfaces

• InlineEditOpenConfigSettingsMessage

Variables

• INLINE_EDIT_OPEN_CONFIG_SETTINGS_MESSAGE

Functions

• inlineEditOpenConfigSettingsMessage
• isInlineEditOpenConfigSettingsMessage

Variables

<Const> INLINE_EDIT_OPEN_CONFIG_SETTINGS_MESSAGE

● INLINE_EDIT_OPEN_CONFIG_SETTINGS_MESSAGE: "inlineedit.openConfigSettings" = "inlineedit.openConfigSettings"

Defined in open.config.settings.message.ts:3

Functions

inlineEditOpenConfigSettingsMessage

▸ inlineEditOpenConfigSettingsMessage(contentId: string, contentName: string): InlineEditOpenConfigSettingsMessage

Defined in open.config.settings.message.ts:12

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string |

Returns: InlineEditOpenConfigSettingsMessage

isInlineEditOpenConfigSettingsMessage

▸ isInlineEditOpenConfigSettingsMessage(aValue: any): boolean

Defined in open.config.settings.message.ts:23

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "open.editor.message"

External module: "open.editor.message"

Index

Interfaces

• InlineEditOpenEditorMessage

Variables

• INLINE_EDIT_OPEN_EDITOR_MESSAGE
• INLINE_EDIT_OPEN_EDITOR_VIEW_COMMENTS

Functions

• inlineEditOpenEditorMessage
• isInlineEditOpenEditorMessage

Variables

<Const> INLINE_EDIT_OPEN_EDITOR_MESSAGE

● INLINE_EDIT_OPEN_EDITOR_MESSAGE: "inlineedit.openEditor" = "inlineedit.openEditor"

Defined in open.editor.message.ts:3

<Const> INLINE_EDIT_OPEN_EDITOR_VIEW_COMMENTS

● INLINE_EDIT_OPEN_EDITOR_VIEW_COMMENTS: "comments" = "comments"

Defined in open.editor.message.ts:5

Functions

inlineEditOpenEditorMessage

▸ inlineEditOpenEditorMessage(contentId: string, contentName: string, view?: string): InlineEditOpenEditorMessage

Defined in open.editor.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string | | Optional view | string |

Returns: InlineEditOpenEditorMessage

isInlineEditOpenEditorMessage

▸ isInlineEditOpenEditorMessage(aValue: any): boolean

Defined in open.editor.message.ts:29

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "open.image.editor.message"

External module: "open.image.editor.message"

Index

Interfaces

• InlineEditOpenImageEditorMessage

Variables

• INLINE_EDIT_OPEN_IMAGE_EDITOR_MESSAGE

Functions

• inlineEditOpenImageEditorMessage
• isInlineEditOpenImageEditorMessage

Variables

<Const> INLINE_EDIT_OPEN_IMAGE_EDITOR_MESSAGE

● INLINE_EDIT_OPEN_IMAGE_EDITOR_MESSAGE: "inlineedit.openImageEditor" = "inlineedit.openImageEditor"

Defined in open.image.editor.message.ts:3

Functions

inlineEditOpenImageEditorMessage

▸ inlineEditOpenImageEditorMessage(contentId: string, accessor: string): InlineEditOpenImageEditorMessage

Defined in open.image.editor.message.ts:21

Creates an inline edit open image editor message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | contentId | string | The content id | | accessor | string | The wch content accessor |

Returns: InlineEditOpenImageEditorMessage an open image editor message

isInlineEditOpenImageEditorMessage

▸ isInlineEditOpenImageEditorMessage(aValue: any): boolean

Defined in open.image.editor.message.ts:35

Whether the specified value is a valid inline edit open image editor message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aValue | any | any value |

Returns: boolean true if the value is a valid message

@ibm-wch-sdk/inline-edit-api > "open.layout.settings.message"

External module: "open.layout.settings.message"

Index

Interfaces

• InlineEditOpenLayoutSettingsMessage

Variables

• INLINE_EDIT_OPEN_LAYOUT_SETTINGS_MESSAGE

Functions

• inlineEditOpenLayoutSettingsMessage
• isInlineEditOpenLayoutSettingsMessage

Variables

<Const> INLINE_EDIT_OPEN_LAYOUT_SETTINGS_MESSAGE

● INLINE_EDIT_OPEN_LAYOUT_SETTINGS_MESSAGE: "inlineedit.openLayoutSettings" = "inlineedit.openLayoutSettings"

Defined in open.layout.settings.message.ts:3

Functions

inlineEditOpenLayoutSettingsMessage

▸ inlineEditOpenLayoutSettingsMessage(contentId: string, contentName: string): InlineEditOpenLayoutSettingsMessage

Defined in open.layout.settings.message.ts:12

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string |

Returns: InlineEditOpenLayoutSettingsMessage

isInlineEditOpenLayoutSettingsMessage

▸ isInlineEditOpenLayoutSettingsMessage(aValue: any): boolean

Defined in open.layout.settings.message.ts:23

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "open.palette.message"

External module: "open.palette.message"

Index

Interfaces

• InlineEditOpenPaletteMessage

Variables

• INLINE_EDIT_OPEN_PALETTE_MESSAGE

Functions

• inlineEditOpenPaletteMessage
• isInlineEditOpenPaletteMessage

Variables

<Const> INLINE_EDIT_OPEN_PALETTE_MESSAGE

● INLINE_EDIT_OPEN_PALETTE_MESSAGE: "inlineedit.openPalette" = "inlineedit.openPalette"

Defined in open.palette.message.ts:4

Functions

inlineEditOpenPaletteMessage

▸ inlineEditOpenPaletteMessage(contentId: string, key: string, assetType: string, accessor: AccessorType): InlineEditOpenPaletteMessage

Defined in open.palette.message.ts:25

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | key | string | | assetType | string | | accessor | AccessorType |

Returns: InlineEditOpenPaletteMessage

isInlineEditOpenPaletteMessage

▸ isInlineEditOpenPaletteMessage(aValue: any): boolean

Defined in open.palette.message.ts:40

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "page.changed.message"

External module: "page.changed.message"

Index

Interfaces

• InlineEditPageChangedMessage

Variables

• INLINE_EDIT_PAGE_CHANGED_MESSAGE

Functions

• inlineEditPageChangedMessage
• isInlineEditPageChangedMessage

Variables

<Const> INLINE_EDIT_PAGE_CHANGED_MESSAGE

● INLINE_EDIT_PAGE_CHANGED_MESSAGE: "inlineedit.pageChanged" = "inlineedit.pageChanged"

Defined in page.changed.message.ts:4

Functions

inlineEditPageChangedMessage

▸ inlineEditPageChangedMessage(page: SitePage): InlineEditPageChangedMessage

Defined in page.changed.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | page | SitePage |

Returns: InlineEditPageChangedMessage

isInlineEditPageChangedMessage

▸ isInlineEditPageChangedMessage(aValue: any): boolean

Defined in page.changed.message.ts:20

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "ready.message"

External module: "ready.message"

Index

Interfaces

• InlineEditReadyMessage

Variables

• INLINE_EDIT_READY_MESSAGE

Functions

• inlineEditReadyMessage
• isInlineEditReadyMessage

Variables

<Const> INLINE_EDIT_READY_MESSAGE

● INLINE_EDIT_READY_MESSAGE: "inlineedit.ready" = "inlineedit.ready"

Defined in ready.message.ts:1

Functions

inlineEditReadyMessage

▸ inlineEditReadyMessage(): InlineEditReadyMessage

Defined in ready.message.ts:7

Returns: InlineEditReadyMessage

isInlineEditReadyMessage

▸ isInlineEditReadyMessage(aValue: any): boolean

Defined in ready.message.ts:13

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "register.message"

External module: "register.message"

Index

Interfaces

• InlineEditRegisterMessage

Variables

• INLINE_EDIT_REGISTER_MESSAGE

Functions

• inlineEditRegisterMessage
• isInlineEditRegisterMessage

Variables

<Const> INLINE_EDIT_REGISTER_MESSAGE

● INLINE_EDIT_REGISTER_MESSAGE: "inlineedit.register" = "inlineedit.register"

Defined in register.message.ts:4

Functions

inlineEditRegisterMessage

▸ inlineEditRegisterMessage(accessor: AccessorType, id: string): InlineEditRegisterMessage

Defined in register.message.ts:12

Parameters:

| Name | Type | | ------ | ------ | | accessor | AccessorType | | id | string |

Returns: InlineEditRegisterMessage

isInlineEditRegisterMessage

▸ isInlineEditRegisterMessage(aValue: any): boolean

Defined in register.message.ts:23

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "resize.message"

External module: "resize.message"

Index

Interfaces

• InlineEditResizeMessage

Variables

• INLINE_EDIT_RESIZE

Functions

• inlineEditResizeMessage
• isInlineEditResizeMessage

Variables

<Const> INLINE_EDIT_RESIZE

● INLINE_EDIT_RESIZE: "inlineedit.resize" = "inlineedit.resize"

Defined in resize.message.ts:3

Functions

inlineEditResizeMessage

▸ inlineEditResizeMessage(width?: number, height?: number): InlineEditResizeMessage

Defined in resize.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | Optional width | number | | Optional height | number |

Returns: InlineEditResizeMessage

isInlineEditResizeMessage

▸ isInlineEditResizeMessage(aValue: any): boolean

Defined in resize.message.ts:22

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "save.completed.message"

External module: "save.completed.message"

Index

Interfaces

• InlineEditSaveCompletedMessage

Variables

• INLINE_EDIT_SAVE_COMPLETED_MESSAGE

Functions

• inlineEditSaveCompletedMessage
• isInlineEditSaveCompletedMessage

Variables

<Const> INLINE_EDIT_SAVE_COMPLETED_MESSAGE

● INLINE_EDIT_SAVE_COMPLETED_MESSAGE: "inlineedit.saveCompleted" = "inlineedit.saveCompleted"

Defined in save.completed.message.ts:3

Functions

inlineEditSaveCompletedMessage

▸ inlineEditSaveCompletedMessage(): InlineEditSaveCompletedMessage

Defined in save.completed.message.ts:9

Returns: InlineEditSaveCompletedMessage

isInlineEditSaveCompletedMessage

▸ isInlineEditSaveCompletedMessage(aValue: any): boolean

Defined in save.completed.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "save.failed.message"

External module: "save.failed.message"

Index

Interfaces

• InlineEditSaveFailedMessage

Variables

• INLINE_EDIT_SAVE_FAILED_MESSAGE

Functions

• inlineEditSaveFailedMessage
• isInlineEditSaveFailedMessage

Variables

<Const> INLINE_EDIT_SAVE_FAILED_MESSAGE

● INLINE_EDIT_SAVE_FAILED_MESSAGE: "inlineedit.saveFailed" = "inlineedit.saveFailed"

Defined in save.failed.message.ts:3

Functions

inlineEditSaveFailedMessage

▸ inlineEditSaveFailedMessage(): InlineEditSaveFailedMessage

Defined in save.failed.message.ts:11

Returns: InlineEditSaveFailedMessage

isInlineEditSaveFailedMessage

▸ isInlineEditSaveFailedMessage(aValue: any): boolean

Defined in save.failed.message.ts:17

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "save.message"

External module: "save.message"

Index

Interfaces

• InlineEditSaveMessage

Variables

• INLINE_EDIT_SAVE_MESSAGE

Functions

• inlineEditSaveMessage
• isInlineEditSaveMessage

Variables

<Const> INLINE_EDIT_SAVE_MESSAGE

● INLINE_EDIT_SAVE_MESSAGE: "inlineedit.save" = "inlineedit.save"

Defined in save.message.ts:3

Functions

inlineEditSaveMessage

▸ inlineEditSaveMessage(contentId: string, contentName: string, elementKey: string, elementType: string, accessor: string, value: string): InlineEditSaveMessage

Defined in save.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string | | elementKey | string | | elementType | string | | accessor | string | | value | string |

Returns: InlineEditSaveMessage

isInlineEditSaveMessage

▸ isInlineEditSaveMessage(aValue: any): boolean

Defined in save.message.ts:34

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "scroll.message"

External module: "scroll.message"

Index

Interfaces

• InlineEditScrollToMessage

Variables

• INLINE_EDIT_SCROLL_TO_MESSAGE

Functions

• inlineEditScrollToMessage
• isInlineEditScrollToMessage

Variables

<Const> INLINE_EDIT_SCROLL_TO_MESSAGE

● INLINE_EDIT_SCROLL_TO_MESSAGE: "inlineedit.scrollTo" = "inlineedit.scrollTo"

Defined in scroll.message.ts:3

Functions

inlineEditScrollToMessage

▸ inlineEditScrollToMessage(contentId: string, element: any): InlineEditScrollToMessage

Defined in scroll.message.ts:12

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | element | any |

Returns: InlineEditScrollToMessage

isInlineEditScrollToMessage

▸ isInlineEditScrollToMessage(aValue: any): boolean

Defined in scroll.message.ts:24

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "transformed.text.finished.message"

External module: "transformed.text.finished.message"

Index

Interfaces

• InlineEditTransformedTextFinishedMessage

Variables

• INLINE_EDIT_TRANSFORMED_TEXT_FINISHED_MESSAGE

Functions

• inlineEditTransformedTextFinishedMessage
• isInlineEditTransformedTextFinishedMessage

Variables

<Const> INLINE_EDIT_TRANSFORMED_TEXT_FINISHED_MESSAGE

● INLINE_EDIT_TRANSFORMED_TEXT_FINISHED_MESSAGE: "inlineedit.transformedText.finished" = "inlineedit.transformedText.finished"

Defined in transformed.text.finished.message.ts:3

Functions

inlineEditTransformedTextFinishedMessage

▸ inlineEditTransformedTextFinishedMessage(): InlineEditTransformedTextFinishedMessage

Defined in transformed.text.finished.message.ts:11

Returns: InlineEditTransformedTextFinishedMessage

isInlineEditTransformedTextFinishedMessage

▸ isInlineEditTransformedTextFinishedMessage(aValue: any): boolean

Defined in transformed.text.finished.message.ts:17

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "transformed.text.message"

External module: "transformed.text.message"

Index

Interfaces

• InlineEditTransformedTextMessage

Variables

• INLINE_EDIT_TRANSFORMED_TEXT_MESSAGE

Functions

• inlineEditTransformedTextMessage
• isInlineEditTransformedTextMessage

Variables

<Const> INLINE_EDIT_TRANSFORMED_TEXT_MESSAGE

● INLINE_EDIT_TRANSFORMED_TEXT_MESSAGE: "inlineedit.transformedText" = "inlineedit.transformedText"

Defined in transformed.text.message.ts:3

Functions

inlineEditTransformedTextMessage

▸ inlineEditTransformedTextMessage(contentId: string, contentName: string, accessor: string, contentValue: string, contentTypeId: string): InlineEditTransformedTextMessage

Defined in transformed.text.message.ts:15

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string | | accessor | string | | contentValue | string | | contentTypeId | string |

Returns: InlineEditTransformedTextMessage

isInlineEditTransformedTextMessage

▸ isInlineEditTransformedTextMessage(aValue: any): boolean

Defined in transformed.text.message.ts:32

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "unlock.message"

External module: "unlock.message"

Index

Interfaces

• InlineEditUnlockMessage

Variables

• INLINE_EDIT_UNLOCK_MESSAGE

Functions

• inlineEditUnlockMessage
• isInlineEditUnlockMessage

Variables

<Const> INLINE_EDIT_UNLOCK_MESSAGE

● INLINE_EDIT_UNLOCK_MESSAGE: "inlineedit.unlock" = "inlineedit.unlock"

Defined in unlock.message.ts:3

Functions

inlineEditUnlockMessage

▸ inlineEditUnlockMessage(contentId: string, contentName: string): InlineEditUnlockMessage

Defined in unlock.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | contentId | string | | contentName | string |

Returns: InlineEditUnlockMessage

isInlineEditUnlockMessage

▸ isInlineEditUnlockMessage(aValue: any): boolean

Defined in unlock.message.ts:22

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "wca.pzn.field.finished.message"

External module: "wca.pzn.field.finished.message"

Index

Enumerations

• WcaPznFieldFinishedResult

Interfaces

• InlineEditWcaPznFieldFinishedMessage

Variables

• INLINE_EDIT_WCA_PZN_FIELD_FINISHED_MESSAGE

Functions

• inlineEditWcaPznFieldFinishedMessage
• isInlineEditWcaPznFieldFinishedMessage

Variables

<Const> INLINE_EDIT_WCA_PZN_FIELD_FINISHED_MESSAGE

● INLINE_EDIT_WCA_PZN_FIELD_FINISHED_MESSAGE: "inlineedit.wcaPznField.finished" = "inlineedit.wcaPznField.finished"

Defined in wca.pzn.field.finished.message.ts:3

Functions

inlineEditWcaPznFieldFinishedMessage

▸ inlineEditWcaPznFieldFinishedMessage(result: WcaPznFieldFinishedResult, ckEditorName: string, pznField?: string): InlineEditWcaPznFieldFinishedMessage

Defined in wca.pzn.field.finished.message.ts:37

Creates a WCA personalization field finished message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | result | WcaPznFieldFinishedResult | the action used to finish choosing a WCA personalization field | | ckEditorName | string | name of the CKEditor instance to insert the chosen personalization field to | | Optional pznField | string | the chosen personalization field in placeholder format (e.g. %%FIRST_NAME%%) |

Returns: InlineEditWcaPznFieldFinishedMessage a WCA personalization field finished message

isInlineEditWcaPznFieldFinishedMessage

▸ isInlineEditWcaPznFieldFinishedMessage(aValue: any): boolean

Defined in wca.pzn.field.finished.message.ts:56

Whether the specified value is a valid WCA personalization field finished message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aValue | any | any value |

Returns: boolean true if the value is a valid message

@ibm-wch-sdk/inline-edit-api > "wca.pzn.field.message"

External module: "wca.pzn.field.message"

Index

Interfaces

• InlineEditWcaPznFieldMessage

Variables

• INLINE_EDIT_WCA_PZN_FIELD_MESSAGE

Functions

• inlineEditWcaPznFieldMessage
• isInlineEditWcaPznFieldMessage

Variables

<Const> INLINE_EDIT_WCA_PZN_FIELD_MESSAGE

● INLINE_EDIT_WCA_PZN_FIELD_MESSAGE: "inlineedit.wcaPznField" = "inlineedit.wcaPznField"

Defined in wca.pzn.field.message.ts:3

Functions

inlineEditWcaPznFieldMessage

▸ inlineEditWcaPznFieldMessage(ckEditorName: string): InlineEditWcaPznFieldMessage

Defined in wca.pzn.field.message.ts:21

Creates a WCA personalization field message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | ckEditorName | string | name of the CKEditor instance to launch the dialog for |

Returns: InlineEditWcaPznFieldMessage a WCA personalization field message

isInlineEditWcaPznFieldMessage

▸ isInlineEditWcaPznFieldMessage(aValue: any): boolean

Defined in wca.pzn.field.message.ts:36

Whether the specified value is a valid WCA personalization field message.

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aValue | any | any value |

Returns: boolean true if the value is a valid message

@ibm-wch-sdk/inline-edit-api > "wch.config.message"

External module: "wch.config.message"

Index

Interfaces

• InlineWchConfigMessage

Variables

• INLINE_EDIT_WCH_CONFIG

Functions

• inlineWchConfigMessage
• isInlineWchConfigMessage

Variables

<Const> INLINE_EDIT_WCH_CONFIG

● INLINE_EDIT_WCH_CONFIG: "inlineedit.wch.config" = "inlineedit.wch.config"

Defined in wch.config.message.ts:4

Functions

inlineWchConfigMessage

▸ inlineWchConfigMessage(config: WchConfig): InlineWchConfigMessage

Defined in wch.config.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | config | WchConfig |

Returns: InlineWchConfigMessage

isInlineWchConfigMessage

▸ isInlineWchConfigMessage(aValue: any): boolean

Defined in wch.config.message.ts:20

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api > "wch.info.message"

External module: "wch.info.message"

Index

Interfaces

• InlineWchInfoMessage

Variables

• INLINE_EDIT_WCH_INFO

Functions

• inlineWchInfoMessage
• isInlineWchInfoMessage

Variables

<Const> INLINE_EDIT_WCH_INFO

● INLINE_EDIT_WCH_INFO: "inlineedit.wch.info" = "inlineedit.wch.info"

Defined in wch.info.message.ts:4

Functions

inlineWchInfoMessage

▸ inlineWchInfoMessage(info: UrlConfig): InlineWchInfoMessage

Defined in wch.info.message.ts:11

Parameters:

| Name | Type | | ------ | ------ | | info | UrlConfig |

Returns: InlineWchInfoMessage

isInlineWchInfoMessage

▸ isInlineWchInfoMessage(aValue: any): boolean

Defined in wch.info.message.ts:18

Parameters:

| Name | Type | | ------ | ------ | | aValue | any |

Returns: boolean

@ibm-wch-sdk/inline-edit-api

Index

External modules

• "active.message"
• "add.content.done.message"
• "add.content.message"
• "approve.message"
• "close.inline.settings.modal.message"
• "close.palette.message"
• "create.channel.message"
• "highlight.message"
• "index"
• "link.finished.message"
• "link.message"
• ["l