Protocols/OSCAR/SNAC/ICBM HOST ACK: Difference between revisions

From NINA Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 18: Line 18:


== SNAC Data ==
== SNAC Data ==
Unconfirmed: This SNAC contains no data
 
"Cookie", "channel", and "username" should be provided in the inter-client message being acknowledged.
 
{| class="wikitable"
! Name
! Type
! Notes
|-
| cookie
| [[Protocols/OSCAR/Foodgroups/ICBM#Datatype:_Cookie|ICBM Cookie]]
| Opaque data generated by conversation initiator and used to link up the conversation and errors
|-
| channel
| uint16 (word)
| ''[Class: [[Protocols/OSCAR/Foodgroups/ICBM#Class:_ICBM_CHANNELS|ICBM__CHANNELS]]]'' Channel the message is on
|-
| username
| string08
| Destination username that should receive the message
|-
| ackTlvs
| Rest of SNAC array of [[Protocols/OSCAR/TLV|TLV]]
| ''[Class: [[Protocols/OSCAR/SNAC/ICBM_HOST_ACK#TLV_Class:_ICBM_ACK_TLV_TAGS|ICBM__ACK_TLV_TAGS]]]'' Extra TLVs in the response
|}


=== TLV Class: ICBM__ACK_TLV_TAGS ===
=== TLV Class: ICBM__ACK_TLV_TAGS ===
These are the TLV tags used in HOST_ACK SNACs. New tags may be defined for future use
{| class="wikitable"
! Name
! Tag
! Type
! Notes
|}


== ICBM SNACs ==
== ICBM SNACs ==

Revision as of 03:58, 23 March 2020

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 Origin Name Foodgroup Service Status Version
0x0004, 0x000C Host ICBM__HOST_ACK Unspecified BOS Active 1.25

This SNAC is sent by the host upon receipt of any ICBM__CHANNEL_MSG_TOHOST which includes the optional ICBM__TLV_TAGS_REQUEST_HOST_ACK TLV.

SNAC Header

Foodgroup uint16 (word) 00 04
Subgroup uint16 (word) 00 0C
Flags uint16 (word) 00 00
Request ID uint32 (dword) 00 00 00 00

SNAC Data

"Cookie", "channel", and "username" should be provided in the inter-client message being acknowledged.

Name Type Notes
cookie ICBM Cookie Opaque data generated by conversation initiator and used to link up the conversation and errors
channel uint16 (word) [Class: ICBM__CHANNELS] Channel the message is on
username string08 Destination username that should receive the message
ackTlvs Rest of SNAC array of TLV [Class: ICBM__ACK_TLV_TAGS] Extra TLVs in the response

TLV Class: ICBM__ACK_TLV_TAGS

These are the TLV tags used in HOST_ACK SNACs. New tags may be defined for future use

Name Tag Type Notes

ICBM SNACs

SNAC List
Subgroup Origin Name
0x0001 Any ICBM__ERR
This is the error SNAC for the ICBM foodgroup.
0x0002 Client ICBM__ADD_PARAMETERS
This SNAC is typically sent prior to sending the OSERVICE__CLIENT_ONLINE so that the host is properly initialized with the clients' preferences.
0x0003 Client ICBM__DEL_PARAMETERS
These are the delete all parameters for a given channel.
0x0004 Client ICBM__PARAMETER_QUERY
This SNAC requests ICBM parameters from the host.
0x0005 Host ICBM__PARAMETER_REPLY
This SNAC is sent by the host in response to a ICBM__PARAMETER_QUERY.
0x0006 Client ICBM__CHANNEL_MSG_TOHOST
This is the basic inter-client message after which the group was named (Inter-Client Basic Messages).
0x0007 Host ICBM__CHANNEL_MSG_TOCLIENT
This is the ICBM__CHANNEL_MSG_TOHOST after it has been reformatted by the host and sent to the destination client.
0x0008 Client ICBM__EVIL_REQUEST
This requests that the specified user is sent an EVIL notification.
0x0009 Host ICBM__EVIL_REPLY
The reply tells the requester, the sender of an ICBM__EVIL_REQUEST SNAC, how much EVIL, if any, was applied to the recipient.
0x000A Host ICBM__MISSED_CALLS
When the host is unable to send one or more messages to the client, the host sends this SNAC to the client to let it know that it missed some messages ("calls").
0x000B Any ICBM__CLIENT_ERR
This error notice is one of the few SNACs that can be sent to the host and received by a client.
0x000C Host ICBM__HOST_ACK
This SNAC is sent by the host upon receipt of any ICBM__CHANNEL_MSG_TOHOST which includes the optional ICBM__TLV_TAGS_REQUEST_HOST_ACK TLV.
0x000D NCD ICBM__SIN_STORED
This is not currently documented. Want to contribute?
0x000E NCD ICBM__SIN_LIST_QUERY
This is not currently documented. Want to contribute?
0x000F NCD ICBM__SIN_LIST_REPLY
This is not currently documented. Want to contribute?
0x0010 Client ICBM__SIN_RETRIEVE
This requests ICBM__CHANNEL_MSG_TOCLIENT messages be generated for each of the stored ICBMs. Any message retrieved is deleted.
0x0011 NCD ICBM__SIN_DELETE
This is not currently documented. Want to contribute?
0x0012 NCD ICBM__NOTIFY_REQUEST
This is not currently documented. Want to contribute?
0x0013 NCD ICBM__NOTIFY_REPLY
This is not currently documented. Want to contribute?
0x0014 Any ICBM__CLIENT_EVENT
This SNAC is sent as a control message, sent by a client to inform the recipient of an event, or by the host informing of an event.
0x0017 Host ICBM__SIN_REPLY
The host successfully processed the request to retrieve all the offline messages.