Documentation

SipDialInFeatures extends Message
in package

Generated from protobuf message <code>plugnmeet.SipDialInFeatures</code>

Table of Contents

Properties

$dispatch_rule_id  : mixed
Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>
$enable_dial_in_on_create  : mixed
If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.
$hide_phone_number  : mixed
Generated from protobuf field <code>bool hide_phone_number = 3;</code>
$is_active  : mixed
all internal usage fields
$is_allow  : mixed
Generated from protobuf field <code>bool is_allow = 1;</code>
$pin  : mixed
Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>
$phone_numbers  : mixed
Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>

Methods

__construct()  : mixed
Constructor.
clearDispatchRuleId()  : mixed
clearPin()  : mixed
getDispatchRuleId()  : string
Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>
getEnableDialInOnCreate()  : bool
If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.
getHidePhoneNumber()  : bool
Generated from protobuf field <code>bool hide_phone_number = 3;</code>
getIsActive()  : bool
all internal usage fields
getIsAllow()  : bool
Generated from protobuf field <code>bool is_allow = 1;</code>
getPhoneNumbers()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>
getPin()  : string
Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>
hasDispatchRuleId()  : mixed
hasPin()  : mixed
setDispatchRuleId()  : $this
Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>
setEnableDialInOnCreate()  : $this
If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.
setHidePhoneNumber()  : $this
Generated from protobuf field <code>bool hide_phone_number = 3;</code>
setIsActive()  : $this
all internal usage fields
setIsAllow()  : $this
Generated from protobuf field <code>bool is_allow = 1;</code>
setPhoneNumbers()  : $this
Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>
setPin()  : $this
Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>

Properties

$dispatch_rule_id

Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>

protected mixed $dispatch_rule_id = null

$enable_dial_in_on_create

If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.

protected mixed $enable_dial_in_on_create = false

If false, this must be done later via a separate API call.

Generated from protobuf field bool enable_dial_in_on_create = 2;

$hide_phone_number

Generated from protobuf field <code>bool hide_phone_number = 3;</code>

protected mixed $hide_phone_number = false

$is_active

all internal usage fields

protected mixed $is_active = false

Generated from protobuf field bool is_active = 4 [(.buf.validate.field) = {

$is_allow

Generated from protobuf field <code>bool is_allow = 1;</code>

protected mixed $is_allow = false

$pin

Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>

protected mixed $pin = null

$phone_numbers

Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>

private mixed $phone_numbers

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type bool $is_allow
@type bool $enable_dial_in_on_create
      If true, the system will immediately prepare the room for SIP dial-in
      by creating a dispatch rule and assigning a PIN upon creation.
      If false, this must be done later via a separate API call.
@type bool $hide_phone_number
@type bool $is_active
      all internal usage fields
@type string[] $phone_numbers
@type string $pin
@type string $dispatch_rule_id

}

getDispatchRuleId()

Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>

public getDispatchRuleId() : string
Return values
string

getEnableDialInOnCreate()

If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.

public getEnableDialInOnCreate() : bool

If false, this must be done later via a separate API call.

Generated from protobuf field bool enable_dial_in_on_create = 2;

Return values
bool

getHidePhoneNumber()

Generated from protobuf field <code>bool hide_phone_number = 3;</code>

public getHidePhoneNumber() : bool
Return values
bool

getIsActive()

all internal usage fields

public getIsActive() : bool

Generated from protobuf field bool is_active = 4 [(.buf.validate.field) = {

Return values
bool

getIsAllow()

Generated from protobuf field <code>bool is_allow = 1;</code>

public getIsAllow() : bool
Return values
bool

getPhoneNumbers()

Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>

public getPhoneNumbers() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

getPin()

Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>

public getPin() : string
Return values
string

setDispatchRuleId()

Generated from protobuf field <code>optional string dispatch_rule_id = 7 [(.buf.validate.field) = {</code>

public setDispatchRuleId(string $var) : $this
Parameters
$var : string
Return values
$this

setEnableDialInOnCreate()

If true, the system will immediately prepare the room for SIP dial-in by creating a dispatch rule and assigning a PIN upon creation.

public setEnableDialInOnCreate(bool $var) : $this

If false, this must be done later via a separate API call.

Generated from protobuf field bool enable_dial_in_on_create = 2;

Parameters
$var : bool
Return values
$this

setHidePhoneNumber()

Generated from protobuf field <code>bool hide_phone_number = 3;</code>

public setHidePhoneNumber(bool $var) : $this
Parameters
$var : bool
Return values
$this

setIsActive()

all internal usage fields

public setIsActive(bool $var) : $this

Generated from protobuf field bool is_active = 4 [(.buf.validate.field) = {

Parameters
$var : bool
Return values
$this

setIsAllow()

Generated from protobuf field <code>bool is_allow = 1;</code>

public setIsAllow(bool $var) : $this
Parameters
$var : bool
Return values
$this

setPhoneNumbers()

Generated from protobuf field <code>repeated string phone_numbers = 5 [(.buf.validate.field) = {</code>

public setPhoneNumbers(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this

setPin()

Generated from protobuf field <code>optional string pin = 6 [(.buf.validate.field) = {</code>

public setPin(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results