Protocols/OSCAR/Foodgroups/LOCATE

From NINA Wiki
Revision as of 08:41, 22 March 2020 by AD (talk | contribs)
Jump to navigation Jump to search
OSCAR Protocol
IntroductionTermsClients
Basic
DatatypesFLAPSNACTLV
UUIDsErrorsTool IDs
Host Interaction
Rate LimitsMigrationMessages
Other Services
ADMINADVERTALERT
BARTBOSBUCPCHAT
CHAT_NAV
Tutorials
Sign OnBARTRendezvous
ICBMLocateBuddies
Foodgroups
OSERVICE (0x0001)
LOCATE (0x0002)
BUDDY (0x0003)
ICBM (0x0004)
ADVERT (0x0005)
INVITE (0x0006)
ADMIN (0x0007)
POPUP (0x0008)
PD (0x0009)
USER_LOOKUP (0x000A)
STATS (0x000B)
TRANSLATE (0x000C)
CHAT_NAV (0x000D)
CHAT (0x000E)
ODIR (0x000F)
BART (0x0010)
FEEDBAG (0x0013)
ICQ (0x0015)
BUCP (0x0017)
ALERT (0x0018)
PLUGIN (0x0022)
UNNAMED_FG_24 (0x0024)
MDIR (0x0025)
ARS (0x044A)
ID Name Service Status Version
0x0002 LOCATE BOS Active 1.19

The LOCATE foodgroup allows the discovery and setting of personalization features such as signatures and away messages. The signature has been surfaced under many different names in NINA products, such as Profile, Buddy Info, and Get Info.

TLV Class: LOCATE__TAGS

These are the possible tags for the SET_INFO and GET_INFO SNACs.

Name Tag Type Notes
LOCATE__TLV_TAGS_INFO_SIG_MIME 0x01 string Signature's MIME type
LOCATE__TLV_TAGS_INFO_SIG_DATA 0x02 string Signature data, also called the get info profile
LOCATE__TLV_TAGS_INFO_UNAVAILABLE_MIME 0x03 string Away message MIME type
LOCATE__TLV_TAGS_INFO_UNAVAILABLE_DATA 0x04 string Away message data
LOCATE__TLV_TAGS_INFO_CAPABILITIES 0x05

Array of [Protocols/OSCAR/UUIDs UUID]

Capabilities of the client
LOCATE__TLV_TAGS_INFO_CERTS 0x06 t70 Public certificates
LOCATE__TLV_TAGS_INFO_SIG_TIME 0x0A t70 Time the signature was set
LOCATE__TLV_TAGS_INFO_UNAVAILABLE_TIME 0x0B t70 Time the away message was set
LOCATE__TLV_TAGS_INFO_SUPPORT_HOST_SIG 0x0C uint8 (byte) If true, enable server based profiles
LOCATE__TLV_TAGS_INFO_HTML_INFO_TYPE 0x0D string Host based Buddy Info MIME type
LOCATE__TLV_TAGS_INFO_HTML_INFO_DATA 0x0E string Host based Buddy Info data that the client should display in a browser window

SNACs

Subgroup Origin Name
0x0001 Any LOCATE__ERR
This is the error SNAC for the LOCATE foodgroup.
0x0002 Client LOCATE__RIGHTS_QUERY
This query is sent to the server by the client to discover what some of its rights are with respect to the PD SNAC group.
0x0003 Host LOCATE__RIGHTS_REPLY
This is the response to the LOCATE__RIGHTS_QUERY SNAC.
0x0004 Client LOCATE__SET_INFO
The client may set SIG, UNAVAILABLE, and CAPABILITIES type and data tags with this SNAC.
0x0005 Client LOCATE__USER_INFO_QUERY
Request user information for profiles, capabilities, away message, and certificates.
0x0006 Host LOCATE__USER_INFO_REPLY
This is the usual response to a LOCATE__USER_INFO_QUERY2 SNAC.
0x0007 Client LOCATE__WATCHER_SUB_REQUEST
Watcher sub request.
0x0008 Host LOCATE__WATCHER_NOTIFICATION
Watcher sub notification.
0x0009 Client LOCATE__SET_DIR_INFO
Set directory info. Host will reply LOCATE__SET_DIR_REPLY.
0x000A Host LOCATE__SET_DIR_REPLY
Reply to LOCATE__SET_DIR_INFO.
0x000B Client LOCATE__GET_DIR_INFO
Get directory information for user. Host should reply with LOCATE__GET_DIR_REPLY.
0x000C Host LOCATE__GET_DIR_REPLY
Host reply to LOCATE__GET_DIR_INFO.
0x000D NCD LOCATE__GROUP_CAPABILITY_QUERY
This is not currently documented. Want to contribute?
0x000E NCD LOCATE__GROUP_CAPABILITY_REPLY
This is not currently documented. Want to contribute?
0x000F Client LOCATE__SET_KEYWORD_INFO
Set profile keywords and interests. Host should reply with LOCATE__SET_KEYWORD_REPLY.
0x0010 Host LOCATE__SET_KEYWORD_REPLY
This is the host reply to LOCATE__SET_KEYWORD_REPLY.
0x0011 Client LOCATE__GET_KEYWORD_INFO
Set profile keywords and interests. Host should reply with LOCATE__SET_KEYWORD_REPLY.
0x0012 Host LOCATE__GET_KEYWORD_REPLY
This is the host reply to LOCATE__SET_KEYWORD_REPLY.
0x0013 Client LOCATE__FIND_LIST_BY_EMAIL
This is a query sent to the server that looks up a list of users by their email address and returns one NickwInfo for each email account queried.
0x0014 Host LOCATE__FIND_LIST_REPLY
This SNAC provides the results of the LOCATE__FIND_LIST_BY_EMAIL.
0x0015 Client LOCATE__USER_INFO_QUERY2
This SNAC is sent by the client to perform the basic locate query on a user.