RedBoxChatEvent

Kind of class:public class
Package:com.smartfoxserver.v2.redbox.events
Inherits from:SFSEvent
Dispatched by:
Author:The gotoAndPlay() Team
http://www.smartfoxserver.com
Classpath:com.smartfoxserver.v2.redbox.events.RedBoxChatEvent
File last modified:Wednesday, 04 May 2011, 18:47:07
RedBoxChatEvent is the class representing all events dispatched by the RedBox's AVChatManager instance, except the connection events (see the RedBoxConnectionEvent class).
The RedBoxChatEvent extends the SFSEvent class, which provides a public property called params of type Object containing event-related parameters.
Usage:
  • Please refer to the specific events for usage examples and params object content.

Summary


Constants
  • RECIPIENT_MISSING : String
    • Dispatched when a chat request is sent, but the recipient is not available.
  • DUPLICATE_REQUEST : String
    • Dispatched when a chat request is sent, but a mutual request has already been sent by the recipient.
  • CHAT_REQUEST : String
    • Dispatched when an a/v chat request is received.
  • CHAT_REFUSED : String
    • Dispatched when an a/v chat request has been refused by the recipient.
  • CHAT_STARTED : String
    • Dispatched when an a/v chat session is started, after the recipient accepted the requester's invitation.
  • CHAT_STOPPED : String
    • Dispatched when an a/v chat session is stopped.

Constants

CHAT_REFUSED

public static const CHAT_REFUSED:String = "onChatRefused"
(read)

Dispatched when an a/v chat request has been refused by the recipient.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the ChatSession object created by the AVChatManager instance when the request was sent.
Example:
  • The following example shows how to handle a chat request refusal.
    avChatMan.addEventListener(RedBoxChatEvent.CHAT_REFUSED, onChatRefused);

// The recipient refuses the chat request...

function onChatRefused(evt:RedBoxChatEvent):void
{
    var chatData:ChatSession = evt.params.chatSession;

    trace ("Chat request refused by user", chatData.mateName);

    // Show message and reset start/stop chat buttons states
    ...
}
See also:

CHAT_REQUEST

public static const CHAT_REQUEST:String = "onChatRequest"
(read)

Dispatched when an a/v chat request is received.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the ChatSession object created by the AVChatManager instance when the request is received.
Example:
  • The following example shows how to handle an incoming chat request.
    avChatMan.addEventListener(RedBoxChatEvent.CHAT_REQUEST, onChatRequest);

// Another user sends a chat request...

function onChatRequest(evt:RedBoxChatEvent):void
{
    var chatData:ChatSession = evt.params.chatSession;

    trace ("Chat request received ->", chatData.toString());

    // Enable "accept" and "decline" buttons
    ...
}
See also:

CHAT_STARTED

public static const CHAT_STARTED:String = "onChatStarted"
(read)

Dispatched when an a/v chat session is started, after the recipient accepted the requester's invitation.
This event is fired on both the requester and the recipient clients.
In order to display the connected users' a/v streams, the ChatSession.myStream and ChatSession.mateStream properties should be used. These two properties are set depending on the request type and on who is the requester.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the ChatSession object created by the AVChatManager instance when the request was sent/received.
Example:
  • The following example shows how to handle a chat starting.
    avChatMan.addEventListener(RedBoxChatEvent.CHAT_STARTED, onChatStarted);

// I'm the recipient accepting the chat request...
avChatMan.acceptChatRequest(chatSessionId);

function onChatStarted(evt:RedBoxChatEvent):void
{
    var chatData:ChatSession = evt.params.chatSession;

    var myStream:NetStream = chatData.myStream;
    var mateStream:NetStream = chatData.mateStream;

    // Attach streams to Video objects on stage
    ...
}
See also:

CHAT_STOPPED

public static const CHAT_STOPPED:String = "onChatStopped"
(read)

Dispatched when an a/v chat session is stopped.
This event is not fired on the client of the user who stopped the chat session, but only on his/her mate's client.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the ChatSession object created by the AVChatManager instance when the request was sent/received.
Example:
  • The following example shows how to handle a chat being stopped.
    avChatMan.addEventListener(RedBoxChatEvent.CHAT_STOPPED, onChatStopped);

avChatMan.stopChat(chatSessionId);

function onChatStopped(evt:RedBoxChatEvent):void
{
    var chatData:ChatSession = evt.params.chatSession;

    // Detach streams from Video objects on stage
    ...
}
See also:

DUPLICATE_REQUEST

public static const DUPLICATE_REQUEST:String = "onDuplicateRequest"
(read)

Dispatched when a chat request is sent, but a mutual request has already been sent by the recipient.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the same ChatSession object returned by the AVChatManager instance when the AVChatManager.sendChatRequest method was called.
Example:
  • The following example shows how to handle the "onDuplicateRequest" event.
    avChatMan.addEventListener(RedBoxChatEvent.DUPLICATE_REQUEST, onDuplicateRequest);

avChatMan.sendChatRequest(AVChatManager.REQ_TYPE_SEND_RECEIVE, buddyId, true, true);

function onDuplicateRequest(evt:RedBoxChatEvent):void
{
    trace ("Request '" + evt.params.chatSession.id + "' error: a mutual request has already been sent by the recipient!");
}
See also:

RECIPIENT_MISSING

public static const RECIPIENT_MISSING:String = "onRecipientMissing"
(read)

Dispatched when a chat request is sent, but the recipient is not available.

The params object contains the following parameters.
Parameters:
chatSession:
(ChatSession) the same ChatSession object returned by the AVChatManager instance when the AVChatManager.sendChatRequest method was called.
Example:
  • The following example shows how to handle the "onRecipientMissing" event.
    avChatMan.addEventListener(RedBoxChatEvent.RECIPIENT_MISSING, onRecipientMissing);

avChatMan.sendChatRequest(AVChatManager.REQ_TYPE_SEND_RECEIVE, buddyId, true, true);

function onRecipientMissing(evt:RedBoxChatEvent):void
{
    trace ("Request '" + evt.params.chatSession.id + "' error: the recipient is not available!");
}
See also:
  • © The gotoAndPlay() Team