Namespace: FlashphonerSFUExtended

FlashphonerSFUExtended

Source:

Namespaces

SFU_OPERATIONS

Methods

(static) addCalendarEvent(event) → {Promise.<(void|error)>}

Add event to the calendar
Parameters:
Name Type Description
event FlashphonerSFUExtended.UserCalendarEvent
Source:
Returns:
Type
Promise.<(void|error)>

(static) addMemberToChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Add member to chat
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) connect(options) → {Promise.<(void|Error)>}

Connect to server.
Parameters:
Name Type Description
options Object SFU options
Properties
Name Type Attributes Description
url String Server url
username String Username
password String Password
nickname String <optional>
 Participant's nickname
Source:
Throws:
Error if no options provided
Type
TypeError
Returns:
Promise which resolves upon connect
Type
Promise.<(void|Error)>

(static) createChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Create chat
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) deleteChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Delete chat
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) disconnect()

Disconnect sfu from the server
Source:

(static) getRoom(options) → {FlashphonerSFU.Room}

Get previously created room. Note that this function will not return ended or failed room
Parameters:
Name Type Description
options Object
Properties
Name Type Description
name String room name
Source:
Throws:
  • Error if no options provided
    Type
    TypeError
  • error if api isn't connected
    Type
    Error
Returns:
Room
Type
FlashphonerSFU.Room

(static) getUserCalendar() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Fetch available calendar from server
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) getUserChats() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Fetch available chats from server
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) getUserList() → {Promise.<Array.<FlashphonerSFUExtended.UserListEntry>>}

Fetch available user list from server
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserListEntry>>

(static) loadChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Fetch chat data from server
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) markMessageRead(msg) → {Promise|Promise.<Array.<FlashphonerSFUExtended.UserListEntry>>}

<<<<<<< HEAD Mark message
Parameters:
Name Type Description
msg Object Message
Properties
Name Type Description
id String Message id
chatId String Indicates chat this message belongs to
Source:
Throws:
error if api isn't connected ======= Fetch available user list from server
Type
Error
Returns:

(static) markMessageUnread(msg) → {Promise}

Mark message
Parameters:
Name Type Description
msg Object Message
Properties
Name Type Description
id String Message id
chatId String Indicates chat this message belongs to
Source:
Throws:
error if api isn't connected
Type
Error
Returns:
Promise resolves with a new state
Type
Promise

(static) off(event, callback) → {FlashphonerSFUExtended}

Remove session event callback.
Parameters:
Name Type Description
event String One of FlashphonerSFU.SFU_EVENT events
callback FlashphonerSFUExtended~eventCallback Callback function
Source:
Throws:
  • Error if event is not specified
    Type
    TypeError
  • Error if callback is not a valid function
    Type
    Error
Returns:
SDK instance callback was removed from
Type
FlashphonerSFUExtended

(static) on(event, callback) → {FlashphonerSFUExtended}

Add session event callback.
Parameters:
Name Type Description
event String One of FlashphonerSFU.SFU_EVENT events
callback FlashphonerSFUExtended~eventCallback Callback function
Source:
Throws:
  • Error if event is not specified
    Type
    TypeError
  • Error if callback is not a valid function
    Type
    Error
Returns:
SDK instance callback was attached to
Type
FlashphonerSFUExtended

(static) removeCalendarEvent(event) → {Promise.<(void|error)>}

Remove event from the calendar
Parameters:
Name Type Description
event FlashphonerSFUExtended.UserCalendarEvent
Source:
Returns:
Type
Promise.<(void|error)>

(static) removeMemberFromChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Remove member from chat
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) renameChat() → {Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>}

Rename chat
Source:
Returns:
Type
Promise.<Array.<FlashphonerSFUExtended.UserCalendar>>

(static) room(options) → {FlashphonerSFU.Room}

Create room
Parameters:
Name Type Description
options Object Room options
Properties
Name Type Description
name String Room name
pin String Room's pin
pc Object Peer connection
Source:
Throws:
  • Error if no options provided
    Type
    TypeError
  • error if api isn't connected
    Type
    Error
Returns:
Room
Type
FlashphonerSFU.Room

(static) sendMessage(msg) → {Promise}

Send message
Parameters:
Name Type Description
msg Object Message
Properties
Name Type Description
to String Recipient's id (deprecated, use chatId instead)
chatId String Indicates chat this message belongs to
body String Message body
attachments Array.<MessageAttachment>
Source:
Throws:
error if api isn't connected
Type
Error
Returns:
Promise will resolve upon message delivery and reject if delivery was unsuccessful
Type
Promise

(static) sfu.server() → {String}

Get hostname of the server in use
Source:
Returns:
Current server's hostname
Type
String

(static) sfu.user() → {FlashphonerSFUExtended.SFUUser}

Get current user
Source:
Returns:
Returns current logged in user
Type
FlashphonerSFUExtended.SFUUser

Type Definitions

Message

Properties:
Name Type Description
id String message id
from String username of the sender
to String username of the recipient
body String message payload
Source:

MessageAttachment

Properties:
Name Type Description
attachment Object attachment info
Properties
Name Type Description
type String "file|picture"
name String name of the attachment
size Number payload size
payload String base64 string that represents content of the attachment
Source:

SFUUser

Type:
  • Object
Properties:
Name Type Description
username String username
nickname String nickname
Source:

UserCalendar

Type:
  • Object
Properties:
Name Type Description
events UserCalendarEvents object with events
Source:

UserCalendarEvent

Type:
  • Object
Properties:
Name Type Description
id String Unique event id
start Number event start time in unix epoch
end Number event end time in unix epoch
title String Event title
description String Event description
accessCode String meeting access code
usePMI Boolean PMI flag
ownerVideo Boolean
participantVideo Boolean
waitingRoom Boolean
recurring Boolean
Source:

UserCalendarEvents

Type:
  • Object.<String, UserCalendarEvent>
Source:

UserListEntry

Type:
  • Object
Properties:
Name Type Description
id String username
nickname String nickname
state String ONLINE or OFFLINE
Source:

eventCallback(sdk)

FlashphonerSFUExtended event callback.
Parameters:
Name Type Description
sdk FlashphonerSFUExtended instance FlashphonerSFUExtended
Source: