#include <protocol.hpp>

Public Attributes
immer::array< std::string >	userFields
	Fields which may be used to identify a third party user. More...

immer::array< std::string >	locationFields
	Fields which may be used to identify a third party location. More...

std::string	icon
	A content URI representing an icon for the third party protocol. More...

immer::map< std::string, FieldType >	fieldTypes
	The type definitions for the fields defined in the `user_fields` and `location_fields`. More...

immer::array< ProtocolInstance >	instances
	A list of objects representing independent instances of configuration. More...

Member Data Documentation

◆ fieldTypes

immer::map<std::string, FieldType> Kazv::Api::ThirdPartyProtocol::fieldTypes

The type definitions for the fields defined in the user_fields and location_fields.

Each entry in those arrays MUST have an entry here. The string key for this object is field name itself.

May be an empty object if no fields are defined.

◆ icon

std::string Kazv::Api::ThirdPartyProtocol::icon

A content URI representing an icon for the third party protocol.

◆ instances

immer::array<ProtocolInstance> Kazv::Api::ThirdPartyProtocol::instances

A list of objects representing independent instances of configuration.

For example, multiple networks on IRC if multiple are provided by the same application service.

◆ locationFields

immer::array<std::string> Kazv::Api::ThirdPartyProtocol::locationFields

Fields which may be used to identify a third party location.

These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the name of a channel.

◆ userFields

immer::array<std::string> Kazv::Api::ThirdPartyProtocol::userFields

Fields which may be used to identify a third party user.

These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the nickname of a user.

The documentation for this struct was generated from the following file: