# @ibm-wch-sdk/inline-edit-api > Exposes framework independent APIs for @ibm-wch-sdk/ng and similar SDKs. Latest version **7.2.608** (published 2019-03-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @ibm-wch-sdk/inline-edit-api pnpm add @ibm-wch-sdk/inline-edit-api yarn add @ibm-wch-sdk/inline-edit-api bun add @ibm-wch-sdk/inline-edit-api ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 7.2.608 | | Published | 2019-03-29 | | First published | 2019-02-02 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 3 | | Unpacked size | 528.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Carsten Leue | | Maintainers | carstenleue, steinheber-ibm | ## Links - npm: https://www.npmjs.com/package/@ibm-wch-sdk/inline-edit-api - Repository: https://github.ibm.com/DX/prod-wch-sdk-ng7 - Issues: https://developer.ibm.com/answers/smartspace/wch/index.html - npm.io page: https://npm.io/package/@ibm-wch-sdk/inline-edit-api ## Dependencies (3) - [tslib](https://npm.io/package/tslib.md) ^1.9.0 - [@ibm-wch-sdk/api](https://npm.io/package/@ibm-wch-sdk/api.md) 7.2.608 - [@ibm-wch-sdk/edit-api](https://npm.io/package/@ibm-wch-sdk/edit-api.md) 7.2.608 ## Recent versions - 7.2.608 (latest) — 2019-03-29 - 7.2.591 — 2019-03-26 - 7.2.435 — 2019-03-05 - 7.2.407 — 2019-03-02 - 7.2.358 — 2019-02-21 - 7.2.291 — 2019-02-02 - 7.2.290 — 2019-02-02 ## README # @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](#_12582009ebaadb6a15359df758c6dc302ed295b663d882488b4017ba8fc7e5b6). ## Changes [CHANGELOG](#_6a4613fd54e183a25f5f9edc57afe92b6413b6c1cc4f70246cc9aff18b3878d8) ## Class documentation Refer to the [documentation](#_07fc3e3f0a90e5b4ec028dbdbbcb2ae68d690cf82df3975bd8efb74f0c36ba69). ## Usage Install the module via ```bash 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"](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) * ["add.content.done.message"](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) * ["add.content.message"](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) * ["approve.message"](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) * ["close.inline.settings.modal.message"](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) * ["close.palette.message"](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) * ["create.channel.message"](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) * ["highlight.message"](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) * ["index"](#_5ccd4d73cc1cdd2aa8f4e5f7a4737bc7f3fd50d7d5c26b8484e764b8b655f040) * ["link.finished.message"](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) * ["link.message"](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) * ["locale.message"](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) * ["message"](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) * ["open.config.settings.message"](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) * ["open.editor.message"](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) * ["open.image.editor.message"](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) * ["open.layout.settings.message"](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) * ["open.palette.message"](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) * ["page.changed.message"](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) * ["ready.message"](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) * ["register.message"](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) * ["resize.message"](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) * ["save.completed.message"](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) * ["save.failed.message"](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) * ["save.message"](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) * ["scroll.message"](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) * ["transformed.text.finished.message"](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) * ["transformed.text.message"](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) * ["unlock.message"](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) * ["wca.pzn.field.finished.message"](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) * ["wca.pzn.field.message"](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) * ["wch.config.message"](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) * ["wch.info.message"](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) --- [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["active.message"](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) # External module: "active.message" ## Index ### Interfaces * [InlineEditActiveMessage](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) ### Variables * [INLINE_EDIT_ACTIVE_EVENT](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) ### Functions * [isInlineEditActiveMessage](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) --- ## Variables ### `` 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["add.content.done.message"](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) # External module: "add.content.done.message" ## Index ### Interfaces * [InlineAddContentDoneMessage](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) ### Variables * [INLINE_EDIT_ADD_CONTENT_DONE](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) ### Functions * [inlineAddContentDoneMessage](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) * [isInlineAddContentDoneMessage](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) --- ## Variables ### `` 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](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) *Defined in add.content.done.message.ts:32* **Parameters:** | Name | Type | | ------ | ------ | | id | `string` | | accessor | `string` | | addedId | `string` | **Returns:** [InlineAddContentDoneMessage](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["add.content.message"](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) # External module: "add.content.message" ## Index ### Enumerations * [ADD_CONTENT_MODE](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573) ### Interfaces * [InlineAddContentMessage](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) ### Variables * [INLINE_EDIT_ADD_CONTENT](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) ### Functions * [inlineAddContentMessage](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) * [isInlineAddContentMessage](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) --- ## Variables ### `` 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](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573)*): [InlineAddContentMessage](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) *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](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573) | optionally the composition mode | **Returns:** [InlineAddContentMessage](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["approve.message"](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) # External module: "approve.message" ## Index ### Interfaces * [InlineEditApproveMessage](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) ### Variables * [INLINE_EDIT_APPROVE_MESSAGE](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) ### Functions * [inlineEditApproveMessage](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) * [isInlineEditApproveMessage](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) --- ## Variables ### `` 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](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) *Defined in approve.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | **Returns:** [InlineEditApproveMessage](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) ___ ### isInlineEditApproveMessage ▸ **isInlineEditApproveMessage**(aValue: *`any`*): `boolean` *Defined in approve.message.ts:22* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["close.inline.settings.modal.message"](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) # External module: "close.inline.settings.modal.message" ## Index ### Interfaces * [InlineEditCloseInlineEditModalMessage](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) ### Variables * [INLINE_EDIT_CLOSE_INLINE_EDIT_MODAL_MESSAGE](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) ### Functions * [inlineEditCloseInlineEditModalMessage](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) * [isInlineEditCloseInlineEditModalMessage](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) --- ## Variables ### `` 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](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) *Defined in close.inline.settings.modal.message.ts:11* **Returns:** [InlineEditCloseInlineEditModalMessage](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["close.palette.message"](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) # External module: "close.palette.message" ## Index ### Interfaces * [InlineEditClosePaletteMessage](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) ### Variables * [INLINE_EDIT_CLOSE_PALETTE_MESSAGE](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) ### Functions * [inlineEditClosePaletteMessage](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) * [isInlineEditClosePaletteMessage](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) --- ## Variables ### `` 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](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) *Defined in close.palette.message.ts:9* **Returns:** [InlineEditClosePaletteMessage](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["create.channel.message"](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) # External module: "create.channel.message" ## Index ### Interfaces * [InlineEditCreateChannelMessage](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) ### Variables * [INLINE_EDIT_CREATE_CHANNEL](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) ### Functions * [inlineEditCreateChannelMessage](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) * [isInlineEditCreateChannelMessage](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) --- ## Variables ### `` 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](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) *Defined in create.channel.message.ts:9* **Returns:** [InlineEditCreateChannelMessage](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["highlight.message"](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) # External module: "highlight.message" ## Index ### Interfaces * [InlineEditHighlightMessage](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) ### Variables * [INLINE_EDIT_HIGHLIGHT_MESSAGE](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) ### Functions * [inlineEditHighlightMessage](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) * [isInlineEditHighlightMessage](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) --- ## Variables ### `` 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](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262)>*, forceOpen: *`boolean`*): [InlineEditHighlightMessage](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) *Defined in highlight.message.ts:13* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | | element | `Array`<[ElementData](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262)> | | forceOpen | `boolean` | **Returns:** [InlineEditHighlightMessage](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) ___ ### isInlineEditHighlightMessage ▸ **isInlineEditHighlightMessage**(aValue: *`any`*): `boolean` *Defined in highlight.message.ts:28* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["index"](#_5ccd4d73cc1cdd2aa8f4e5f7a4737bc7f3fd50d7d5c26b8484e764b8b655f040) # External module: "index" ## Index --- [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["link.finished.message"](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) # External module: "link.finished.message" ## Index ### Interfaces * [InlineEditLinkFinishedMessage](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) ### Variables * [INLINE_EDIT_LINK_FINISHED_MESSAGE](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) ### Functions * [inlineEditLinkFinishedMessage](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) * [isInlineEditLinkFinishedMessage](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) --- ## Variables ### `` 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](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) *Defined in link.finished.message.ts:9* **Returns:** [InlineEditLinkFinishedMessage](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["link.message"](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) # External module: "link.message" ## Index ### Interfaces * [InlineEditLinkMessage](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) ### Variables * [INLINE_EDIT_LINK_MESSAGE](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) ### Functions * [inlineEditLinkMessage](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) * [isInlineEditLinkMessage](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) --- ## Variables ### `` 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](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) *Defined in link.message.ts:14* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | accessor | `string` | | linkURL | `string` | | linkText | `string` | | linkDescription | `string` | **Returns:** [InlineEditLinkMessage](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) ___ ### isInlineEditLinkMessage ▸ **isInlineEditLinkMessage**(aValue: *`any`*): `boolean` *Defined in link.message.ts:31* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["locale.message"](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) # External module: "locale.message" ## Index ### Interfaces * [InlineEditLocaleMessage](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) ### Variables * [INLINE_EDIT_LOCALE_MESSAGE](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) ### Functions * [inlineEditLocaleMessage](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) * [isInlineEditLocaleMessage](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) --- ## Variables ### `` INLINE_EDIT_LOCALE_MESSAGE **● INLINE_EDIT_LOCALE_MESSAGE**: *"inlineedit.locale"* = "inlineedit.locale" *Defined in locale.message.ts:1* ___ ## Functions ### inlineEditLocaleMessage ▸ **inlineEditLocaleMessage**(aLocale?: *`string`*): [InlineEditLocaleMessage](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) *Defined in locale.message.ts:8* **Parameters:** | Name | Type | | ------ | ------ | | `Optional` aLocale | `string` | **Returns:** [InlineEditLocaleMessage](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) ___ ### isInlineEditLocaleMessage ▸ **isInlineEditLocaleMessage**(aValue: *`any`*): `boolean` *Defined in locale.message.ts:20* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["message"](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) # External module: "message" ## Index ### Interfaces * [ElementData](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262) * [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) ### Functions * [isInlineEditMessage](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) --- ## 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.config.settings.message"](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) # External module: "open.config.settings.message" ## Index ### Interfaces * [InlineEditOpenConfigSettingsMessage](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) ### Variables * [INLINE_EDIT_OPEN_CONFIG_SETTINGS_MESSAGE](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) ### Functions * [inlineEditOpenConfigSettingsMessage](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) * [isInlineEditOpenConfigSettingsMessage](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) --- ## Variables ### `` 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](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) *Defined in open.config.settings.message.ts:12* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | **Returns:** [InlineEditOpenConfigSettingsMessage](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.editor.message"](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) # External module: "open.editor.message" ## Index ### Interfaces * [InlineEditOpenEditorMessage](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) ### Variables * [INLINE_EDIT_OPEN_EDITOR_MESSAGE](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) * [INLINE_EDIT_OPEN_EDITOR_VIEW_COMMENTS](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) ### Functions * [inlineEditOpenEditorMessage](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) * [isInlineEditOpenEditorMessage](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) --- ## Variables ### `` INLINE_EDIT_OPEN_EDITOR_MESSAGE **● INLINE_EDIT_OPEN_EDITOR_MESSAGE**: *"inlineedit.openEditor"* = "inlineedit.openEditor" *Defined in open.editor.message.ts:3* ___ ### `` 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](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) *Defined in open.editor.message.ts:15* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | | `Optional` view | `string` | **Returns:** [InlineEditOpenEditorMessage](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.image.editor.message"](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) # External module: "open.image.editor.message" ## Index ### Interfaces * [InlineEditOpenImageEditorMessage](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) ### Variables * [INLINE_EDIT_OPEN_IMAGE_EDITOR_MESSAGE](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) ### Functions * [inlineEditOpenImageEditorMessage](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) * [isInlineEditOpenImageEditorMessage](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) --- ## Variables ### `` 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](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) *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](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.layout.settings.message"](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) # External module: "open.layout.settings.message" ## Index ### Interfaces * [InlineEditOpenLayoutSettingsMessage](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) ### Variables * [INLINE_EDIT_OPEN_LAYOUT_SETTINGS_MESSAGE](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) ### Functions * [inlineEditOpenLayoutSettingsMessage](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) * [isInlineEditOpenLayoutSettingsMessage](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) --- ## Variables ### `` 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](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) *Defined in open.layout.settings.message.ts:12* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | **Returns:** [InlineEditOpenLayoutSettingsMessage](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.palette.message"](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) # External module: "open.palette.message" ## Index ### Interfaces * [InlineEditOpenPaletteMessage](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) ### Variables * [INLINE_EDIT_OPEN_PALETTE_MESSAGE](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) ### Functions * [inlineEditOpenPaletteMessage](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) * [isInlineEditOpenPaletteMessage](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) --- ## Variables ### `` 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](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) *Defined in open.palette.message.ts:25* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | key | `string` | | assetType | `string` | | accessor | `AccessorType` | **Returns:** [InlineEditOpenPaletteMessage](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["page.changed.message"](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) # External module: "page.changed.message" ## Index ### Interfaces * [InlineEditPageChangedMessage](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) ### Variables * [INLINE_EDIT_PAGE_CHANGED_MESSAGE](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) ### Functions * [inlineEditPageChangedMessage](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) * [isInlineEditPageChangedMessage](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) --- ## Variables ### `` 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](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) *Defined in page.changed.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | page | `SitePage` | **Returns:** [InlineEditPageChangedMessage](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["ready.message"](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) # External module: "ready.message" ## Index ### Interfaces * [InlineEditReadyMessage](#_68b31b087acd144f1dd41eef280a16d9bf19e165c2c74fb3d0979b90bef6f3c2) ### Variables * [INLINE_EDIT_READY_MESSAGE](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) ### Functions * [inlineEditReadyMessage](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) * [isInlineEditReadyMessage](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) --- ## Variables ### `` INLINE_EDIT_READY_MESSAGE **● INLINE_EDIT_READY_MESSAGE**: *"inlineedit.ready"* = "inlineedit.ready" *Defined in ready.message.ts:1* ___ ## Functions ### inlineEditReadyMessage ▸ **inlineEditReadyMessage**(): [InlineEditReadyMessage](#_68b31b087acd144f1dd41eef280a16d9bf19e165c2c74fb3d0979b90bef6f3c2) *Defined in ready.message.ts:7* **Returns:** [InlineEditReadyMessage](#_68b31b087acd144f1dd41eef280a16d9bf19e165c2c74fb3d0979b90bef6f3c2) ___ ### isInlineEditReadyMessage ▸ **isInlineEditReadyMessage**(aValue: *`any`*): `boolean` *Defined in ready.message.ts:13* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["register.message"](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) # External module: "register.message" ## Index ### Interfaces * [InlineEditRegisterMessage](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) ### Variables * [INLINE_EDIT_REGISTER_MESSAGE](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) ### Functions * [inlineEditRegisterMessage](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) * [isInlineEditRegisterMessage](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) --- ## Variables ### `` 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](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) *Defined in register.message.ts:12* **Parameters:** | Name | Type | | ------ | ------ | | accessor | `AccessorType` | | id | `string` | **Returns:** [InlineEditRegisterMessage](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) ___ ### isInlineEditRegisterMessage ▸ **isInlineEditRegisterMessage**(aValue: *`any`*): `boolean` *Defined in register.message.ts:23* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["resize.message"](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) # External module: "resize.message" ## Index ### Interfaces * [InlineEditResizeMessage](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) ### Variables * [INLINE_EDIT_RESIZE](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) ### Functions * [inlineEditResizeMessage](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) * [isInlineEditResizeMessage](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) --- ## Variables ### `` INLINE_EDIT_RESIZE **● INLINE_EDIT_RESIZE**: *"inlineedit.resize"* = "inlineedit.resize" *Defined in resize.message.ts:3* ___ ## Functions ### inlineEditResizeMessage ▸ **inlineEditResizeMessage**(width?: *`number`*, height?: *`number`*): [InlineEditResizeMessage](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) *Defined in resize.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | `Optional` width | `number` | | `Optional` height | `number` | **Returns:** [InlineEditResizeMessage](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) ___ ### isInlineEditResizeMessage ▸ **isInlineEditResizeMessage**(aValue: *`any`*): `boolean` *Defined in resize.message.ts:22* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.completed.message"](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) # External module: "save.completed.message" ## Index ### Interfaces * [InlineEditSaveCompletedMessage](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) ### Variables * [INLINE_EDIT_SAVE_COMPLETED_MESSAGE](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) ### Functions * [inlineEditSaveCompletedMessage](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) * [isInlineEditSaveCompletedMessage](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) --- ## Variables ### `` 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](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) *Defined in save.completed.message.ts:9* **Returns:** [InlineEditSaveCompletedMessage](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.failed.message"](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) # External module: "save.failed.message" ## Index ### Interfaces * [InlineEditSaveFailedMessage](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) ### Variables * [INLINE_EDIT_SAVE_FAILED_MESSAGE](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) ### Functions * [inlineEditSaveFailedMessage](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) * [isInlineEditSaveFailedMessage](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) --- ## Variables ### `` 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](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) *Defined in save.failed.message.ts:11* **Returns:** [InlineEditSaveFailedMessage](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.message"](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) # External module: "save.message" ## Index ### Interfaces * [InlineEditSaveMessage](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) ### Variables * [INLINE_EDIT_SAVE_MESSAGE](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) ### Functions * [inlineEditSaveMessage](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) * [isInlineEditSaveMessage](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) --- ## Variables ### `` 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](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) *Defined in save.message.ts:15* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | | elementKey | `string` | | elementType | `string` | | accessor | `string` | | value | `string` | **Returns:** [InlineEditSaveMessage](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) ___ ### isInlineEditSaveMessage ▸ **isInlineEditSaveMessage**(aValue: *`any`*): `boolean` *Defined in save.message.ts:34* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["scroll.message"](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) # External module: "scroll.message" ## Index ### Interfaces * [InlineEditScrollToMessage](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) ### Variables * [INLINE_EDIT_SCROLL_TO_MESSAGE](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) ### Functions * [inlineEditScrollToMessage](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) * [isInlineEditScrollToMessage](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) --- ## Variables ### `` 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](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) *Defined in scroll.message.ts:12* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | element | `any` | **Returns:** [InlineEditScrollToMessage](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) ___ ### isInlineEditScrollToMessage ▸ **isInlineEditScrollToMessage**(aValue: *`any`*): `boolean` *Defined in scroll.message.ts:24* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["transformed.text.finished.message"](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) # External module: "transformed.text.finished.message" ## Index ### Interfaces * [InlineEditTransformedTextFinishedMessage](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) ### Variables * [INLINE_EDIT_TRANSFORMED_TEXT_FINISHED_MESSAGE](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) ### Functions * [inlineEditTransformedTextFinishedMessage](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) * [isInlineEditTransformedTextFinishedMessage](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) --- ## Variables ### `` 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](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) *Defined in transformed.text.finished.message.ts:11* **Returns:** [InlineEditTransformedTextFinishedMessage](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["transformed.text.message"](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) # External module: "transformed.text.message" ## Index ### Interfaces * [InlineEditTransformedTextMessage](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) ### Variables * [INLINE_EDIT_TRANSFORMED_TEXT_MESSAGE](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) ### Functions * [inlineEditTransformedTextMessage](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) * [isInlineEditTransformedTextMessage](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) --- ## Variables ### `` 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](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) *Defined in transformed.text.message.ts:15* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | | accessor | `string` | | contentValue | `string` | | contentTypeId | `string` | **Returns:** [InlineEditTransformedTextMessage](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["unlock.message"](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) # External module: "unlock.message" ## Index ### Interfaces * [InlineEditUnlockMessage](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) ### Variables * [INLINE_EDIT_UNLOCK_MESSAGE](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) ### Functions * [inlineEditUnlockMessage](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) * [isInlineEditUnlockMessage](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) --- ## Variables ### `` 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](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) *Defined in unlock.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | contentId | `string` | | contentName | `string` | **Returns:** [InlineEditUnlockMessage](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) ___ ### isInlineEditUnlockMessage ▸ **isInlineEditUnlockMessage**(aValue: *`any`*): `boolean` *Defined in unlock.message.ts:22* **Parameters:** | Name | Type | | ------ | ------ | | aValue | `any` | **Returns:** `boolean` ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wca.pzn.field.finished.message"](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) # External module: "wca.pzn.field.finished.message" ## Index ### Enumerations * [WcaPznFieldFinishedResult](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961) ### Interfaces * [InlineEditWcaPznFieldFinishedMessage](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) ### Variables * [INLINE_EDIT_WCA_PZN_FIELD_FINISHED_MESSAGE](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) ### Functions * [inlineEditWcaPznFieldFinishedMessage](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) * [isInlineEditWcaPznFieldFinishedMessage](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) --- ## Variables ### `` 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](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961)*, ckEditorName: *`string`*, pznField?: *`string`*): [InlineEditWcaPznFieldFinishedMessage](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) *Defined in wca.pzn.field.finished.message.ts:37* Creates a WCA personalization field finished message. **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | result | [WcaPznFieldFinishedResult](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961) | 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](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wca.pzn.field.message"](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) # External module: "wca.pzn.field.message" ## Index ### Interfaces * [InlineEditWcaPznFieldMessage](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) ### Variables * [INLINE_EDIT_WCA_PZN_FIELD_MESSAGE](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) ### Functions * [inlineEditWcaPznFieldMessage](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) * [isInlineEditWcaPznFieldMessage](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) --- ## Variables ### `` 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](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) *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](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wch.config.message"](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) # External module: "wch.config.message" ## Index ### Interfaces * [InlineWchConfigMessage](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) ### Variables * [INLINE_EDIT_WCH_CONFIG](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) ### Functions * [inlineWchConfigMessage](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) * [isInlineWchConfigMessage](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) --- ## Variables ### `` 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](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) *Defined in wch.config.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | config | `WchConfig` | **Returns:** [InlineWchConfigMessage](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) ___ ### 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](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wch.info.message"](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) # External module: "wch.info.message" ## Index ### Interfaces * [InlineWchInfoMessage](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) ### Variables * [INLINE_EDIT_WCH_INFO](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) ### Functions * [inlineWchInfoMessage](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) * [isInlineWchInfoMessage](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) --- ## Variables ### `` 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](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) *Defined in wch.info.message.ts:11* **Parameters:** | Name | Type | | ------ | ------ | | info | `UrlConfig` | **Returns:** [InlineWchInfoMessage](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) ___ ### 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"](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) * ["add.content.done.message"](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) * ["add.content.message"](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) * ["approve.message"](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) * ["close.inline.settings.modal.message"](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) * ["close.palette.message"](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) * ["create.channel.message"](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) * ["highlight.message"](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) * ["index"](#_5ccd4d73cc1cdd2aa8f4e5f7a4737bc7f3fd50d7d5c26b8484e764b8b655f040) * ["link.finished.message"](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) * ["link.message"](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) * ["locale.message"](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) * ["message"](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) * ["open.config.settings.message"](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) * ["open.editor.message"](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) * ["open.image.editor.message"](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) * ["open.layout.settings.message"](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) * ["open.palette.message"](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) * ["page.changed.message"](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) * ["ready.message"](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) * ["register.message"](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) * ["resize.message"](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) * ["save.completed.message"](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) * ["save.failed.message"](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) * ["save.message"](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) * ["scroll.message"](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) * ["transformed.text.finished.message"](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) * ["transformed.text.message"](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) * ["unlock.message"](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) * ["wca.pzn.field.finished.message"](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) * ["wca.pzn.field.message"](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) * ["wch.config.message"](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) * ["wch.info.message"](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) --- [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["active.message"](#_dbdfcd4b96c533e13707031d6c226742afc67bb02566b48ca8bc57ec32a75cf3) > [InlineEditActiveMessage](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) # Interface: InlineEditActiveMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditActiveMessage** ## Index ### Properties * [action](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [highContrastMode](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [page](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [sitesApprovalToggleEnabled](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [sitesConfigurationHiddenToggleEnabled](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [sitesConfigurationSettingsToggleEnabled](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [translation](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) * [value](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) --- ## Properties ### action **● action**: *"inlineedit.active"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in active.message.ts:5* ___ ### highContrastMode **● highContrastMode**: *`boolean`* *Defined in active.message.ts:6* ___ ### page **● page**: *`any`* *Defined in active.message.ts:7* ___ ### `` sitesApprovalToggleEnabled **● sitesApprovalToggleEnabled**: *`boolean`* *Defined in active.message.ts:8* ___ ### `` sitesConfigurationHiddenToggleEnabled **● sitesConfigurationHiddenToggleEnabled**: *`boolean`* *Defined in active.message.ts:10* ___ ### `` sitesConfigurationSettingsToggleEnabled **● sitesConfigurationSettingsToggleEnabled**: *`boolean`* *Defined in active.message.ts:9* ___ ### translation **● translation**: *`Record`<`string`, `string`>* *Defined in active.message.ts:11* ___ ### value **● value**: *`boolean`* *Defined in active.message.ts:12* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["add.content.done.message"](#_c832958bc661e5cb572f43ca19d13adb79900ce07dac6432d32a36c3a20d1c25) > [InlineAddContentDoneMessage](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) # Interface: InlineAddContentDoneMessage Message that confirms the edit operation on a particular item ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineAddContentDoneMessage** ## Index ### Properties * [accessor](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) * [action](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) * [addedId](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) * [bCanceled](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) * [error](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) * [id](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in add.content.done.message.ts:17* The accessor string that points to the content reference to be edited. This can e.g. be 'elements.multiref.values\[1\]' or 'elements.singleref.value' ___ ### action **● action**: *"inlineedit.add.content.done"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in add.content.done.message.ts:10* ___ ### `` addedId **● addedId**: *`string`* *Defined in add.content.done.message.ts:25* The id of the new item ___ ### `` bCanceled **● bCanceled**: *`boolean`* *Defined in add.content.done.message.ts:21* true if the operation has been canceled, false otherwise ___ ### `` error **● error**: *`any`* *Defined in add.content.done.message.ts:29* A potential error message that occurred during the edit operation ___ ### id **● id**: *`string`* *Defined in add.content.done.message.ts:12* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["add.content.message"](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) > [ADD_CONTENT_MODE](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573) # Enumeration: ADD_CONTENT_MODE ## Index ### Enumeration members * [COMPOSE](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573) * [FIND](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573) --- ## Enumeration members ### COMPOSE **COMPOSE**: *Defined in add.content.message.ts:9* ___ ### FIND **FIND**: *Defined in add.content.message.ts:7* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["add.content.message"](#_d2ae7e3a3ae8025c9b6a39f21489df5750b906b3c036b101d7658c1f92204077) > [InlineAddContentMessage](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) # Interface: InlineAddContentMessage Message that requests a content reference to be filled out. Expects to get a 'add.content.done.message' when complete. *__see__*: AddContentDoneMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineAddContentMessage** ## Index ### Properties * [accessor](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) * [action](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) * [id](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) * [mode](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in add.content.message.ts:26* The accessor string that points to the content reference to be edited. This can e.g. be 'elements.multiref.values\[1\]' or 'elements.singleref.value' ___ ### action **● action**: *"inlineedit.add.content"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in add.content.message.ts:19* ___ ### id **● id**: *`string`* *Defined in add.content.message.ts:21* ___ ### `` mode **● mode**: *[ADD_CONTENT_MODE](#_0a67f7cbb7bc7583904d0a6ad4560cd0ef66e294e1365978ce24feb5179b2573)* *Defined in add.content.message.ts:30* The composition mode ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["approve.message"](#_476d19cc0b6f6fa4215bbcde20a544b634fd88d0a911defc4afc0ca1ed9d1c4a) > [InlineEditApproveMessage](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) # Interface: InlineEditApproveMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditApproveMessage** ## Index ### Properties * [action](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) * [contentId](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) * [contentName](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) --- ## Properties ### action **● action**: *"inlineedit.approve"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in approve.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in approve.message.ts:7* ___ ### contentName **● contentName**: *`string`* *Defined in approve.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["close.inline.settings.modal.message"](#_d79b0e5ac3330e049cb25af484af6c048171543b181a24a23dc1adff8f62e73b) > [InlineEditCloseInlineEditModalMessage](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) # Interface: InlineEditCloseInlineEditModalMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditCloseInlineEditModalMessage** ## Index ### Properties * [action](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) --- ## Properties ### action **● action**: *"inlineedit.closeInlineSettingsModal"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in close.inline.settings.modal.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["close.palette.message"](#_bb36e4e034e0b327a87b371bcd012a435640c7bd11c27aeb2c02e68ab3cf1128) > [InlineEditClosePaletteMessage](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) # Interface: InlineEditClosePaletteMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditClosePaletteMessage** ## Index ### Properties * [action](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) --- ## Properties ### action **● action**: *"inlineedit.closePalette"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in close.palette.message.ts:6* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["create.channel.message"](#_3e14c37f8cccc7bd6851c5ed68bee1ead32f315ce653e5ac697ffaa3ce8d57b2) > [InlineEditCreateChannelMessage](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) # Interface: InlineEditCreateChannelMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditCreateChannelMessage** ## Index ### Properties * [action](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) --- ## Properties ### action **● action**: *"inlineedit.create.channel"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in create.channel.message.ts:6* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["highlight.message"](#_d4e61996fb99ce51831ff0b5c9d72a3d7f26ffdce7e119fa7f0c9214c82047df) > [InlineEditHighlightMessage](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) # Interface: InlineEditHighlightMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditHighlightMessage** ## Index ### Properties * [action](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) * [contentId](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) * [contentName](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) * [element](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) * [forceOpen](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) --- ## Properties ### action **● action**: *"inlineedit.highlight"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in highlight.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in highlight.message.ts:7* ___ ### contentName **● contentName**: *`string`* *Defined in highlight.message.ts:8* ___ ### element **● element**: *`Array`<[ElementData](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262)>* *Defined in highlight.message.ts:9* ___ ### forceOpen **● forceOpen**: *`boolean`* *Defined in highlight.message.ts:10* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["message"](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) > [ElementData](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262) # Interface: ElementData ## Hierarchy **ElementData** ## Index ### Properties * [entry](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262) * [key](#_c2a8cfde9f2752c8d195ddd837a9404b333cfd6f49261f2daebcd194e37d7262) --- ## Properties ### `` entry **● entry**: *`any`* *Defined in message.ts:11* ___ ### key **● key**: *`string`* *Defined in message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["link.finished.message"](#_98c94dfdc5ccb042e7c0ea8391858f6a764608f483fcf1e430717d7ec6e69737) > [InlineEditLinkFinishedMessage](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) # Interface: InlineEditLinkFinishedMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditLinkFinishedMessage** ## Index ### Properties * [action](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) --- ## Properties ### action **● action**: *"inlineedit.link.finished"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in link.finished.message.ts:6* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["link.message"](#_577a0588e51d70a03a1de375d08c28fab4c0a0c5b9c84fdaa4927211cad46a76) > [InlineEditLinkMessage](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) # Interface: InlineEditLinkMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditLinkMessage** ## Index ### Properties * [accessor](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) * [action](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) * [contentId](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) * [linkDescription](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) * [linkText](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) * [linkURL](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in link.message.ts:8* ___ ### action **● action**: *"inlineedit.link"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in link.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in link.message.ts:7* ___ ### linkDescription **● linkDescription**: *`string`* *Defined in link.message.ts:11* ___ ### linkText **● linkText**: *`string`* *Defined in link.message.ts:10* ___ ### linkURL **● linkURL**: *`string`* *Defined in link.message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["locale.message"](#_de6fb4b40af15188f24882912ffd35011f910b5c78df3b6cfde6896eaa05e521) > [InlineEditLocaleMessage](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) # Interface: InlineEditLocaleMessage ## Hierarchy **InlineEditLocaleMessage** ## Index ### Properties * [action](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) * [locale](#_0ed51b2bc8d4c7874d212ad239fef29c7953c10891323dfcbcce5a804dd02204) --- ## Properties ### action **● action**: *"inlineedit.locale"* *Defined in locale.message.ts:4* ___ ### `` locale **● locale**: *`string`* *Defined in locale.message.ts:5* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["message"](#_0034d610b06fbef50b0862c9bfea0c076e8ff7216007c0fe9e0f0d80ce76400d) > [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) # Interface: InlineEditMessage Base interface for inline edit messages ## Hierarchy **InlineEditMessage** ↳ [InlineEditActiveMessage](#_7d9ccc9650744a6a4160840b23ac63f7966b9f5193e96512b1f56c0aaafbe427) ↳ [InlineAddContentDoneMessage](#_a0726636b6e54d2d19a653fb3538bd1614ac97117b0f4c3d7d428e9436818294) ↳ [InlineAddContentMessage](#_bfaa7a7b95142a57501c247185bfa4aa517e5548266a6bcd35c12948e7ecda41) ↳ [InlineEditApproveMessage](#_20252276b7d0603f220f053d5533def15a39fc0ceaa99a930b1e5f277f8ffc22) ↳ [InlineEditCloseInlineEditModalMessage](#_cf4bc0307187085a9d7a1e71ce8d78202ecffa25efd0cd4cc2fc04cabee4b7ab) ↳ [InlineEditClosePaletteMessage](#_f70c31ee7e054396652720c99efb1a56a5bda9f81746ce46a85cfb2a89281e5a) ↳ [InlineEditCreateChannelMessage](#_f6cd79c8a5b248cc53800dee3230ef7755a712e3a464e94230bbd20b56b16da0) ↳ [InlineEditHighlightMessage](#_ce955947dbc65e171874b81356f7f0c2c18bad22d56a96cf94b141ea9106cc32) ↳ [InlineEditLinkFinishedMessage](#_5059cb555363128e8b86a9e0b841c2921a6c7193403062de6ca362e518f96794) ↳ [InlineEditLinkMessage](#_2609262222e2f4709bfea9cd7d03a6bff9e2f12a3f731d3d04b10ad03afd8c64) ↳ [InlineEditOpenConfigSettingsMessage](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) ↳ [InlineEditOpenEditorMessage](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) ↳ [InlineEditOpenImageEditorMessage](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) ↳ [InlineEditOpenLayoutSettingsMessage](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) ↳ [InlineEditOpenPaletteMessage](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) ↳ [InlineEditPageChangedMessage](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) ↳ [InlineEditRegisterMessage](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) ↳ [InlineEditResizeMessage](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) ↳ [InlineEditSaveCompletedMessage](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) ↳ [InlineEditSaveFailedMessage](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) ↳ [InlineEditSaveMessage](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) ↳ [InlineEditScrollToMessage](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) ↳ [InlineEditTransformedTextFinishedMessage](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) ↳ [InlineEditTransformedTextMessage](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) ↳ [InlineEditUnlockMessage](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) ↳ [InlineEditWcaPznFieldFinishedMessage](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) ↳ [InlineEditWcaPznFieldMessage](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) ↳ [InlineWchConfigMessage](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) ↳ [InlineWchInfoMessage](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) ## Index ### Properties * [action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) --- ## Properties ### action **● action**: *`string`* *Defined in message.ts:5* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.config.settings.message"](#_0848271f04462bce05d3a2b12cac40a981e8a3b9f8896439e99786f0f050138a) > [InlineEditOpenConfigSettingsMessage](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) # Interface: InlineEditOpenConfigSettingsMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditOpenConfigSettingsMessage** ## Index ### Properties * [action](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) * [contentId](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) * [contentName](#_a78104ec2972f4b09d13179bca4608c6f90cec40b6cbd7387e4c7df55f0539c4) --- ## Properties ### action **● action**: *"inlineedit.openConfigSettings"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in open.config.settings.message.ts:7* ___ ### contentId **● contentId**: *`string`* *Defined in open.config.settings.message.ts:8* ___ ### contentName **● contentName**: *`string`* *Defined in open.config.settings.message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.editor.message"](#_e05b3216ea2ec081145a8309a9c57656964538588e0a83ebd68edc7c0e41e82e) > [InlineEditOpenEditorMessage](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) # Interface: InlineEditOpenEditorMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditOpenEditorMessage** ## Index ### Properties * [action](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) * [contentId](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) * [contentName](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) * [view](#_c6b14e94265d97033c6262bfdcce27171ce87987e47be3a01190abe3e1b4a1c8) --- ## Properties ### action **● action**: *"inlineedit.openEditor"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in open.editor.message.ts:8* ___ ### contentId **● contentId**: *`string`* *Defined in open.editor.message.ts:9* ___ ### contentName **● contentName**: *`string`* *Defined in open.editor.message.ts:10* ___ ### `` view **● view**: *`string`* *Defined in open.editor.message.ts:12* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.image.editor.message"](#_af15c62db65405e7f40c1b2dadbe77e5447e9cc2d2258855bd84df88340d21f3) > [InlineEditOpenImageEditorMessage](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) # Interface: InlineEditOpenImageEditorMessage Message to open the image element editor via inline editing ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditOpenImageEditorMessage** ## Index ### Properties * [accessor](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) * [action](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) * [contentId](#_9fd049f425515878e93ead81c38188ea1fea84c50c6cd3a078c3ca65ad0484a7) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in open.image.editor.message.ts:11* ___ ### action **● action**: *"inlineedit.openImageEditor"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in open.image.editor.message.ts:9* ___ ### contentId **● contentId**: *`string`* *Defined in open.image.editor.message.ts:10* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.layout.settings.message"](#_b76539ddeaac7ee450abdfd3b98bc736dc421ec102a3948c326980ce80d234a0) > [InlineEditOpenLayoutSettingsMessage](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) # Interface: InlineEditOpenLayoutSettingsMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditOpenLayoutSettingsMessage** ## Index ### Properties * [action](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) * [contentId](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) * [contentName](#_baece6945437472891d4f6fffde26e69d9af8a5fbe14c3386a6ae9c6a2995729) --- ## Properties ### action **● action**: *"inlineedit.openLayoutSettings"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in open.layout.settings.message.ts:7* ___ ### contentId **● contentId**: *`string`* *Defined in open.layout.settings.message.ts:8* ___ ### contentName **● contentName**: *`string`* *Defined in open.layout.settings.message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["open.palette.message"](#_73af970116e622a7beb0032ed3520389e5285a0280ad62dabd72a30c9a6f8153) > [InlineEditOpenPaletteMessage](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) # Interface: InlineEditOpenPaletteMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditOpenPaletteMessage** ## Index ### Properties * [accessor](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) * [action](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) * [assetType](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) * [contentId](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) * [key](#_8f366bfdf1f7a6af98ef5ee4d487e5a8d88dce3eb18aa54a8ee02d9fcdccab8a) --- ## Properties ### accessor **● accessor**: *`AccessorType`* *Defined in open.palette.message.ts:22* The accessor expression, starting at the content item level ___ ### action **● action**: *"inlineedit.openPalette"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in open.palette.message.ts:7* ___ ### assetType **● assetType**: *`string`* *Defined in open.palette.message.ts:18* The element type of the item ___ ### contentId **● contentId**: *`string`* *Defined in open.palette.message.ts:9* The authoring ID of the content item, i.e. typically the draft ID ___ ### key **● key**: *`string`* *Defined in open.palette.message.ts:14* The element key to the item to be edited. For custom elements this is the key of the inner element type ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["page.changed.message"](#_03b598eb289a8931a71d20e710609b8d23973902b4877f6c3aad63eceb3a02ae) > [InlineEditPageChangedMessage](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) # Interface: InlineEditPageChangedMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditPageChangedMessage** ## Index ### Properties * [action](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) * [page](#_611cc2bce424afe39ba0cdabc604477ea931e7f1ab296d6542608c9ee7e2a106) --- ## Properties ### action **● action**: *"inlineedit.pageChanged"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in page.changed.message.ts:7* ___ ### page **● page**: *`SitePage`* *Defined in page.changed.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["ready.message"](#_0778285a482462bcc14aee9ffbee298c2d59d1673e61652efad69a0cffb1cd01) > [InlineEditReadyMessage](#_68b31b087acd144f1dd41eef280a16d9bf19e165c2c74fb3d0979b90bef6f3c2) # Interface: InlineEditReadyMessage ## Hierarchy **InlineEditReadyMessage** ## Index ### Properties * [type](#_68b31b087acd144f1dd41eef280a16d9bf19e165c2c74fb3d0979b90bef6f3c2) --- ## Properties ### type **● type**: *"inlineedit.ready"* *Defined in ready.message.ts:4* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["register.message"](#_1d1dcd4b75037729aaf0b6f05c974da31afb521e2864450b5b9b1634e7f2499d) > [InlineEditRegisterMessage](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) # Interface: InlineEditRegisterMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditRegisterMessage** ## Index ### Properties * [accessor](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) * [action](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) * [id](#_45dcaa5eed8946392cacc841b6aedc3d3e6ee7bbdb10a6bd6bb76b05adceff0c) --- ## Properties ### accessor **● accessor**: *`AccessorType`* *Defined in register.message.ts:8* ___ ### action **● action**: *"inlineedit.register"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in register.message.ts:7* ___ ### id **● id**: *`string`* *Defined in register.message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["resize.message"](#_1e91e1d435170276b47d23f898c784d87047274fa55b7373ce336ac2b549429f) > [InlineEditResizeMessage](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) # Interface: InlineEditResizeMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditResizeMessage** ## Index ### Properties * [action](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) * [height](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) * [width](#_900a1ee8de6edf76e1cd4893ad3cda51cdc9695935ab523c3a0423ed09b6e9f5) --- ## Properties ### action **● action**: *"inlineedit.resize"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in resize.message.ts:6* ___ ### `` height **● height**: *`number`* *Defined in resize.message.ts:8* ___ ### `` width **● width**: *`number`* *Defined in resize.message.ts:7* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.completed.message"](#_f80707a16bda2fa18b0feb1de5a0697c03608a76ee76ce8f313e49099d278074) > [InlineEditSaveCompletedMessage](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) # Interface: InlineEditSaveCompletedMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditSaveCompletedMessage** ## Index ### Properties * [action](#_590f16b768731ecdf2cb93e96336effdaba3c3c7ce80250c46c31436e1acb14a) --- ## Properties ### action **● action**: *"inlineedit.saveCompleted"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in save.completed.message.ts:6* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.failed.message"](#_76a1b7618a43daa549297429c23bf4109fadfeba81484516facf3a8941de32a8) > [InlineEditSaveFailedMessage](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) # Interface: InlineEditSaveFailedMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditSaveFailedMessage** ## Index ### Properties * [action](#_8224c96e227a743acd55b7ec66f5d3cce9e8ff38e3bb61809c8b0e1e2426c355) --- ## Properties ### action **● action**: *"inlineedit.saveFailed"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in save.failed.message.ts:6* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["save.message"](#_3196f49ea9f7a5d08891398a34c640b17b4e2e77862c4eff817bdcb735b7f8ed) > [InlineEditSaveMessage](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) # Interface: InlineEditSaveMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditSaveMessage** ## Index ### Properties * [accessor](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [action](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [contentId](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [contentName](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [elementKey](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [elementType](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) * [value](#_a69f508f2a11274380158ba8967ce386f2b241e9bdde4ee63bbd3cef267b72a2) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in save.message.ts:11* ___ ### action **● action**: *"inlineedit.save"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in save.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in save.message.ts:9* ___ ### contentName **● contentName**: *`string`* *Defined in save.message.ts:10* ___ ### elementKey **● elementKey**: *`string`* *Defined in save.message.ts:7* ___ ### elementType **● elementType**: *`string`* *Defined in save.message.ts:8* ___ ### value **● value**: *`string`* *Defined in save.message.ts:12* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["scroll.message"](#_918a4e28081d3f949e355283907d9922026f8a201697f03fd053f5159e072c5f) > [InlineEditScrollToMessage](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) # Interface: InlineEditScrollToMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditScrollToMessage** ## Index ### Properties * [action](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) * [contentId](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) * [element](#_7c44a6b96601f61200192406c4d7c465212857e728644fce47edb9c3eba5bccd) --- ## Properties ### action **● action**: *"inlineedit.scrollTo"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in scroll.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in scroll.message.ts:7* ___ ### element **● element**: *`any`* *Defined in scroll.message.ts:9* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["transformed.text.finished.message"](#_c295c7b2d8e1d9d651cb0825cf5c483bd9214cc6744d8822e3679bb40c805415) > [InlineEditTransformedTextFinishedMessage](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) # Interface: InlineEditTransformedTextFinishedMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditTransformedTextFinishedMessage** ## Index ### Properties * [action](#_9603af3e9762c32cc3274487fad7703d4c00802b82b2cc84ee4cc29667742e11) --- ## Properties ### action **● action**: *"inlineedit.transformedText.finished"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in transformed.text.finished.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["transformed.text.message"](#_a1be85102d5e87959accabd4b491b9d3adb495393e5b8c04fe6a3f3c9ba8e683) > [InlineEditTransformedTextMessage](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) # Interface: InlineEditTransformedTextMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditTransformedTextMessage** ## Index ### Properties * [accessor](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) * [action](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) * [contentId](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) * [contentName](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) * [contentTypeId](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) * [contentValue](#_519795250bc3fb3f571410a0e933425d6be181ce9da7cd96d37d4c96a489fa78) --- ## Properties ### accessor **● accessor**: *`string`* *Defined in transformed.text.message.ts:10* ___ ### action **● action**: *"inlineedit.transformedText"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in transformed.text.message.ts:7* ___ ### contentId **● contentId**: *`string`* *Defined in transformed.text.message.ts:8* ___ ### contentName **● contentName**: *`string`* *Defined in transformed.text.message.ts:9* ___ ### contentTypeId **● contentTypeId**: *`string`* *Defined in transformed.text.message.ts:12* ___ ### contentValue **● contentValue**: *`string`* *Defined in transformed.text.message.ts:11* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["unlock.message"](#_57dd7093baf168443c0af8a92201829ec02474aa3571a3aabda0d7fd7cf63929) > [InlineEditUnlockMessage](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) # Interface: InlineEditUnlockMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditUnlockMessage** ## Index ### Properties * [action](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) * [contentId](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) * [contentName](#_b9ef2889e42b11b46fe7d1bee1a9845408c5c812604d161a27e382bf65387473) --- ## Properties ### action **● action**: *"inlineedit.unlock"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in unlock.message.ts:6* ___ ### contentId **● contentId**: *`string`* *Defined in unlock.message.ts:7* ___ ### contentName **● contentName**: *`string`* *Defined in unlock.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wca.pzn.field.finished.message"](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) > [WcaPznFieldFinishedResult](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961) # Enumeration: WcaPznFieldFinishedResult Possible actions performed when choosing a WCA personalization field has finished. ## Index ### Enumeration members * [APPLY](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961) * [CANCEL](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961) --- ## Enumeration members ### APPLY **APPLY**: = "apply" *Defined in wca.pzn.field.finished.message.ts:9* ___ ### CANCEL **CANCEL**: = "cancel" *Defined in wca.pzn.field.finished.message.ts:10* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wca.pzn.field.finished.message"](#_b640f7fbb7a01875e73b4c4aa835a0d72a4402bb105e6178147562351ab1e3c5) > [InlineEditWcaPznFieldFinishedMessage](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) # Interface: InlineEditWcaPznFieldFinishedMessage Message that indicates choosing a WCA personalization field has finished. ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditWcaPznFieldFinishedMessage** ## Index ### Properties * [action](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) * [ckEditorName](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) * [pznField](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) * [result](#_d3033d522a310361c05873d80f114748eb502ee0232cab5b096aaf611407425f) --- ## Properties ### action **● action**: *"inlineedit.wcaPznField.finished"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in wca.pzn.field.finished.message.ts:17* ___ ### ckEditorName **● ckEditorName**: *`string`* *Defined in wca.pzn.field.finished.message.ts:23* ___ ### `` pznField **● pznField**: *`string`* *Defined in wca.pzn.field.finished.message.ts:26* ___ ### result **● result**: *[WcaPznFieldFinishedResult](#_b252b1667b83b4b9ecd17d94bd61c64a7ae6dd76f6c33780c8602226a79fa961)* *Defined in wca.pzn.field.finished.message.ts:20* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wca.pzn.field.message"](#_32d5f67d27f886eafcd195effda9b3884b42fd20669eb68b73a18a229cf132a3) > [InlineEditWcaPznFieldMessage](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) # Interface: InlineEditWcaPznFieldMessage Message to launch the dialog for choosing a WCA personalization field. ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineEditWcaPznFieldMessage** ## Index ### Properties * [action](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) * [ckEditorName](#_1c4d09b4f43e4a44f7e56439983ef79ad7fd7ee2126181dacc01886c6cf148fc) --- ## Properties ### action **● action**: *"inlineedit.wcaPznField"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in wca.pzn.field.message.ts:9* ___ ### ckEditorName **● ckEditorName**: *`string`* *Defined in wca.pzn.field.message.ts:12* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wch.config.message"](#_d32eb152218d71c9f1a7ad4b3bb881b1dfcacda2c3b1f8f8f04f65bd31b17931) > [InlineWchConfigMessage](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) # Interface: InlineWchConfigMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineWchConfigMessage** ## Index ### Properties * [action](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) * [config](#_292da7fe5d05aea8fef11e42dcd5530044e24c2d15451d2732d76ad852231e17) --- ## Properties ### action **● action**: *"inlineedit.wch.config"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in wch.config.message.ts:7* ___ ### config **● config**: *`WchConfig`* *Defined in wch.config.message.ts:8* ___ [@ibm-wch-sdk/inline-edit-api](#_5e7167da50177490d07d2d9819695a358c9a90d385991650113f0ad1fd4448ce) > ["wch.info.message"](#_6abce872b71c8ed599f9dd4e1ac61939e97b16f983d3ba5351add93207995e72) > [InlineWchInfoMessage](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) # Interface: InlineWchInfoMessage ## Hierarchy [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5) **↳ InlineWchInfoMessage** ## Index ### Properties * [action](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) * [info](#_79b9fa811a0715aa44f901777a3cbe6468206db72958db89295bc1299f77ee78) --- ## Properties ### action **● action**: *"inlineedit.wch.info"* *Overrides [InlineEditMessage](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5).[action](#_b38c95aa492fc6294738fb4cd09e7da8aa5820187ecf0cfee8745cff04a0f4b5)* *Defined in wch.info.message.ts:7* ___ ### info **● info**: *`UrlConfig`* *Defined in wch.info.message.ts:8* ___ --- _Source: https://npm.io/package/@ibm-wch-sdk/inline-edit-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._