Documentation

imconnector.register

The method registers new type of connector.

note: to display the connector in the general list of connectors on site, use the method imconnector.connector.data.set.

Parameters

Parameter Description Available from version
ID Connector unique ID. Its recommended to be preceded by a prefix, to avoid matching the current and possible future connector IDs. The following symbols be used: digits, letters, underscore.
NAME Displayed connector name.
ICON Array of connector icon description, where:
  • DATA_IMAGE - DATA-image of SVG icon.

    Example

  • COLOR - color. Example: #1900ff
  • SIZE - size. Example: 90%
  • POSITION - position SVG. Example: center
PLACEMENT_HANDLER Link to URL of placement handler to be called to show to users the connector setting in the slider. In contrast to basic placement feature, in this case only the handler URL is specified, i. e. no need to set a specific placement location ID.
ICON_DISABLED Array of connector icon description for inactive option, where:
  • DATA_IMAGE - DATA-image of SVG icon. For conversion, use the service http://www.grumpicon.com/.

    Example

  • COLOR - color. Example: #1900ff
  • SIZE - size. Example: 90%
  • POSITION - position SVG. Example: center
DEL_EXTERNAL_MESSAGES Enable deleting external messages? Default: yes.
EDIT_INTERNAL_MESSAGES Enable editing internal messages? Default: yes.
DEL_INTERNAL_MESSAGES Enable deleting internal messages? Default: yes.
NEWSLETTER Enable using channel for CRM-newsletter? Default: yes.
NEED_SYSTEM_MESSAGES Enable system messages in Open Channel? Default: yes.
Examples: greetings, final phrase and etc.
NEED_SIGNATURE Enable sending signature in inside message? Default: yes.
Example: string with operator name is added in front of message text.
CHAT_GROUP Is external chat of this open channel the group chat? Can different third-party people write inside a single chat? Default: no.
CHAT_GROUP Y\N. By default - Y. Indicates this Open Channel chat as a group chat externally. By default, external users cannot write in this chat. Also, leads and other CRM entities cannot be created.
COMMENT Description for placement location handler (see. parameter PLACEMENT_HANDLER).
Note: optional parameters are selected in italics.


© «Bitrix24», 2001-2024