SipRegisterWaitCommand Object


Description:

Waits for SIP UA blocks to register. If one of the selected SIP UA blocks registered unsuccessfully, this command will block the command sequence from continuing. Otherwise, this command will not block the command sequence.

Can be used with Command Sequencer: Yes

GUI Command Name: SIP: Wait for UA Blocks to Register

Parents: Sequencer

SipRegisterWaitCommand Writable Attributes

Attribute Description
Common Writable Attributes ErrorOnFailure
BlockRegistrationState

Block registration state.

Type: enum

Default: REGISTRATION_SUCCEEDED

Possible Values:

Value Description
NOT_REGISTERED

Not registered.

REGISTERING

Registering.

REGISTRATION_SUCCEEDED

Registration succeeded.

REGISTRATION_FAILED

Registration failed.

REGISTRATION_CANCELED

Registration canceled.

UNREGISTERING

Unregistering.

ObjectList

List of object handles (that is, Project, Port, or EmulatedDevice) to wait for idle state on.

Type: handle

Default: 0

WaitTime

Wait time (seconds).

Type: double

Default: 30.0

Range: 0.005 - 2147483647.0

SipRegisterWaitCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes PassFailState, Successful, Unsuccessful