File: chat_invite

package info (click to toggle)
pork 0.99.7-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,396 kB
  • ctags: 3,949
  • sloc: ansic: 34,135; sh: 3,392; perl: 797; makefile: 535
file content (14 lines) | stat: -rw-r--r-- 591 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
SYNTAX: PORK::chat_invite(chat_room, user, msg, [account])
	Invites a user to a chat room with an optional message.

INPUT PARAMETERS
	chat_room: The name/exchange combination of the chat room to which to invite the user.
	user     : The user to invite.
	msg      : A message to be sent with the chat invitation. Specify undef to send no message.
	account  : (Optional) The account on whose behalf the action will be performed. If this parameter is omitted, the account active in the current window will be assumed.

RETURN VALUE
	Returns 0 on success, -1 on failure.

SEE ALSO
	chat invite