Интерфейс RestConvertible

Граф наследования:RestConvertible:

Открытые члены
	toRestFormat (array $option=[])

Открытые статические члены
static	getRestEntityName ()

Подробное описание

См. определение в файле RestConvertible.php строка 5

Методы

getRestEntityName()

getRestEntityName ( )

static

Returns the name of the entity that will be used in the rest response

Возвращает

string

Замещается в AnchorCollection, AnchorItem, CallToken, ChatPopupItem, CollabInfo, CommentPopupItem, CopilotPopupItem, EntityLink, Chat, MemberCollection, MemberCursor, MemberItem, MessagesAutoDeleteConfigs, CalendarCollection, CalendarItem, Command, Department, Departments, FileCollection, FileItem, FilePopupItem, TaskCollection, TaskItem, RichData, UrlCollection, UrlItem, BotData, User, UserCollection, UserPopupItem, UserShortPopupItem, ViewCollection, ViewItem, BaseLinkCollection, CalendarItem, FavoriteItem, FileItem, PinCollection, PinItem, ReminderItem, ReminderPopupItem, TaskItem, UrlItem, Entity, Application, AdditionalMessagePopupItem, Message, MessagePopupItem, ReactionCollection, ReactionItem, ReactionMessage, ReactionMessages, ReactionPopupItem, MessageCollection, Promotion, PromotionList, PromotionParams, PromotionUpdateData, BirthdayPopupItem, ChatRecentConfig, Recent, RecentItem, Relation, RelationCursor, RelationCollection, RestAdapter, General, Notify, Preset и TariffLimitPopupItem.

toRestFormat()

toRestFormat

(

array

$option = []

)

Returns an array in JSON like format to return the entity as a rest response.

Аргументы

array

$option

Возвращает

array|null

Замещается в AnchorItem, CallToken, ChatPopupItem, CollabInfo, Entity, CommentPopupItem, CopilotPopupItem, EntityLink, MemberCursor, MemberItem, MessagesAutoDeleteConfigs, Chat, CalendarItem, Command, Department, EntityCollection, FileItem, FilePopupItem, TaskItem, RichData, UrlItem, BotData, User, UserBot, UserCollection, UserPopupItem, UserShortPopupItem, ViewItem, BaseLinkCollection, BaseLinkItem, FavoriteCollection, FavoriteItem, FileItem, PinItem, ReminderCollection, ReminderItem, ReminderPopupItem, Entity, Application, MessagePopupItem, ReactionCollection, ReactionItem, ReactionMessage, ReactionMessages, ReactionPopupItem, Message, MessageCollection, Promotion, PromotionList, PromotionParams, PromotionUpdateData, BirthdayPopupItem, ChatRecentConfig, Recent, RecentItem, RelationCursor, Relation, RelationCollection, RestAdapter, General, Notify, Preset, ChatsSync, RecentSyncItem и TariffLimitPopupItem.

---

Объявления и описания членов интерфейса находятся в файле:

• C:/bitrix/modules/im/lib/V2/Rest/RestConvertible.php