Protocols/OSCAR/UUIDs

From NINA Wiki
Revision as of 03:34, 17 March 2020 by AD (talk | contribs) (Created page with "{{Protocols/OSCAR}} OSCAR uses UUIDs in several places to express what kind of capabilities a client has and what features it would like the server to support. The nice thing...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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)


OSCAR uses UUIDs in several places to express what kind of capabilities a client has and what features it would like the server to support. The nice thing about UUIDs is there does not have to be a central registry since they are unique when created. There are many websites and tools out there that will create a UUID. UUIDs are also sometimes known as GUIDs.

UUIDs are transmitted as 16 bytes of binary data; however in documents they are written down in string form like 09460000-4C7F-11D1-8222-444553540000.

At some point it was decided that full UUIDs were too verbose for common capabilities, so AIM uses both full UUIDs and what are called "short UUIDs" or "Short Caps". A "Short Cap" is really a UUID of the form 0946XXYY-4C7F-11D1-8222-444553540000 where XXYY is the short cap. A client receives short caps if it asserts the short cap capability. If a client does not assert the short caps UUID, it will get most caps in long form. Some APIs only take UUIDs In those cases the long form of a short cap should be sent.

Client and library developers should feel free to create valid new UUIDs, just do not create new "Short Caps". If developers would like to publish their UUIDs and what they mean, we will be happy to document them here.

Name UUID Notes
SHORT_CAPS 09460000-4C7F-11D1-8222-444553540000 Client support short caps
SECURE_IM 09460001-4C7F-11D1-8222-444553540000 Client supports SECURE_IM
XHTML_IM 09460002-4C7F-11D1-8222-444553540000 Client supports XHTML profile and ims instead of AOLRTF
RTCVIDEO 09460101-4C7F-11D1-8222-444553540000 Client supports SIP/RTP video
HAS_CAMERA 09460102-4C7F-11D1-8222-444553540000 Client has a camera
HAS_MICROPHONE 09460103-4C7F-11D1-8222-444553540000 Client has a microphone
RTCAUDIO 09460104-4C7F-11D1-8222-444553540000 Client supports RTCAUDIO
HOST_STATUS_TEXT_AWARE 0946010A-4C7F-11D1-8222-444553540000 Client supports new status message features
RTIM 0946010B-4C7F-11D1-8222-444553540000 Client support "see as I type" IMs
SMART_CAPS 094601FF-4C7F-11D1-8222-444553540000 Client only asserts caps for services it is participating in
FILE_TRANSFER 09461343-4C7F-11D1-8222-444553540000 File transfer
DIRECT_ICBM 09461345-4C7F-11D1-8222-444553540000 P2p ims
FILE_SHARING 09461348-4C7F-11D1-8222-444553540000 File sharing
SUPPORT_ICQ 0946134D-4C7F-11D1-8222-444553540000 Client supports talking to ICQ users