PitelUA class

The User-Agent class. @class DartSIP.UA @param {Object} configuration Configuration parameters. @throws {DartSIP.Exceptions.ConfigurationError} If a configuration parameter is invalid. @throws {TypeError} If no configuration is given.

Inheritance

Constructors

PitelUA(PitelSipSettings? configuration)

Properties

configuration PitelSipSettings?
no setter
contact Contact?
no setter
hashCode int
The hash code for this object.
no setterinherited
listeners Map<Type, List>
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status int?
no setter
transactions TransactionBag
no setter
transport Transport?
no setter

Methods

addAllEventHandlers(EventManager other) → void
add all event handlers from an other instance of EventManager to this one.
inherited
call(String target, Map<String, dynamic> options) RTCSession
Make an outgoing call.
destroyDialog(Dialog dialog) → void
Dialog destroyed.
destroyMessage(Message message) → void
Message destroyed.
destroyRTCSession(RTCSession session) → void
RTCSession destroyed.
destroyTransaction(TransactionBase transaction) → void
Transaction destroyed.
emit<T extends EventType>(T event) → void
send the supplied event to all of the listeners that are subscribed to that EventType
inherited
get(String parameter) String?
Allow retrieving configuration and autogenerated fields in runtime.
hasListeners(EventType event) bool
returns true if there are any listeners associated with the EventType for this instance of EventManager
inherited
isConnected() bool
Connection state.
isRegistered() bool?
Registration state.
newDialog(Dialog dialog) → void
Dialog
newMessage(Message message, String originator, dynamic request) → void
Message
newRTCSession({required RTCSession session, String? originator, dynamic request}) → void
RTCSession
newTransaction(TransactionBase transaction) → void
Transaction
normalizeTarget(String? target) URI?
Normalice a string into a valid SIP request URI -param {String} target -returns {DartSIP.URI|null}
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<T extends EventType>(T eventType, void listener(T event)) → void
call "on" to subscribe to events of a particular type
inherited
onTransportConnect(Transport transport) → void
onTransportConnecting(WebSocketInterface? socket, int? attempts) → void
Transport event handlers
onTransportData(Transport transport, String messageData) → void
onTransportDisconnect(WebSocketInterface? socket, ErrorCause cause) → void
receiveRequest(IncomingRequest request) → void
Request reception
register() → void
Register.
registered({required dynamic response}) → void
Registered
registrationFailed({required dynamic response, String? cause}) → void
Registration Failed
registrator() Registrator?
Get the Registrator instance.
remove<T extends EventType>(T eventType, void listener(T event)?) → void
inherited
sendMessage(String target, String body, Map<String, dynamic>? options) Message
Send a message.
set(String parameter, dynamic value) bool
Allow configuration changes in runtime. Returns true if the parameter could be set.
start() → void
Connect to the server if status = STATUS_INIT. Resume UA after being closed.
stop() → void
Gracefully close.
terminateSessions(Map<String, dynamic> options) → void
Terminate ongoing sessions.
toString() String
A string representation of this object.
inherited
unregister({bool all = false}) → void
Unregister.
unregistered({dynamic response, String? cause}) → void
Unregistered

Operators

operator ==(Object other) bool
The equality operator.
inherited