Protocols/OSCAR/SNAC/INVITE REQUEST QUERY: 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
 
The server will perform a lookup on the email address and if already a member will return an error.
 
{| class="wikitable"
! Name
! Type
! Notes
|-
| inviteTLVs
| Rest of SNAC array of [[Protocols/OSCAR/TLV|TLV]]
| ''[Class: [[Protocols/OSCAR/SNAC/INVITE_REQUEST_QUERY#TLV_Class:_INVITE_TAGS|INVITE__TAGS]]]'' Email and message to send
|}


=== TLV Class: INVITE__TAGS ===
=== TLV Class: INVITE__TAGS ===
These are the tags used when inviting a user to join the AIM service.
{| class="wikitable"
! Name
! Tag
! Type
! Notes
|-
| INVITE__TLV_TAGS_EMAIL
| 0x11
| string
| Email address to invite
|-
| INVITE__TLV_TAGS_PERSONALIZED_TEXT
| 0x15
| string
| Personalized message to send in an invite
|}


== INVITE SNACs ==
== INVITE SNACs ==

Revision as of 03:59, 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
0x0006, 0x0002 Client INVITE__REQUEST_QUERY Unspecified BOS Active 1.5

This SNAC contains a request to send an invite to join NINA to a given email address.

SNAC Header

Foodgroup uint16 (word) 00 06
Subgroup uint16 (word) 00 02
Flags uint16 (word) 00 00
Request ID uint32 (dword) 00 00 00 00

SNAC Data

The server will perform a lookup on the email address and if already a member will return an error.

Name Type Notes
inviteTLVs Rest of SNAC array of TLV [Class: INVITE__TAGS] Email and message to send

TLV Class: INVITE__TAGS

These are the tags used when inviting a user to join the AIM service.

Name Tag Type Notes
INVITE__TLV_TAGS_EMAIL 0x11 string Email address to invite
INVITE__TLV_TAGS_PERSONALIZED_TEXT 0x15 string Personalized message to send in an invite

INVITE SNACs

SNAC List
Subgroup Origin Name
0x0001 Any INVITE__ERR
This is the error SNAC for the INVITE foodgroup.
0x0002 Client INVITE__REQUEST_QUERY
This SNAC contains a request to send an invite to join NINA to a given email address.
0x0003 Host INVITE__REQUEST_REPLY
This SNAC is sent in reply to a successful INVITE__REQUEST_QUERY.