ContractInfoUpdate extends CommonContractInfo
Defines a contract common properties
Table of Contents
- $activationEndTime : int|null
- The activation end time (in milliseconds) of the contract. 0 means no activation time limit.
- $automaticRenewal : bool|null
- True if automatic renewal is allowed.
- $bidir : bool|null
- True if the contract info is bidirectional.
- $blacklistedTerritories : array<string|int, mixed>|null
- The list of "blacklisted" territories, as an array of NIP group IDs.
- $communicationEndTime : int|null
- The end time (in milliseconds) of the communication. 0 means no communication time limit.
- $highPriorityDownlink : bool|null
- True if all downlinks are high priority.
- $maxDownlinkFrames : int|null
- The maximum number of downlink frames.
- $maxTokens : int|null
- The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.
- $maxUplinkFrames : int|null
- The maximum number of uplink frames.
- $name : string|null
- The contract name
- $options : array<string|int, mixed>|null
- The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.
- $orderName : string|null
- The order name, if any. This field can be unset when updating.
- $renewalDuration : int|null
- The renewal duration in months.
- from() : static
- Initializing a model from an array
- getActivationEndTime() : int
- Getter for activationEndTime
- getAutomaticRenewal() : bool
- Getter for automaticRenewal
- getBidir() : bool
- Getter for bidir
- getBlacklistedTerritories() : array<string|int, string>
- Getter for blacklistedTerritories
- getCommunicationEndTime() : int
- Getter for communicationEndTime
- getHighPriorityDownlink() : bool
- Getter for highPriorityDownlink
- getMaxDownlinkFrames() : int
- Getter for maxDownlinkFrames
- getMaxTokens() : int
- Getter for maxTokens
- getMaxUplinkFrames() : int
- Getter for maxUplinkFrames
- getName() : string
- Getter for name
- getOptions() : array<string|int, OptionsItem>
- Getter for options
- getOrderName() : string
- Getter for orderName
- getRenewalDuration() : int
- Getter for renewalDuration
- jsonSerialize() : array<string|int, mixed>
- setActivationEndTime() : static
- Setter for activationEndTime
- setAutomaticRenewal() : static
- Setter for automaticRenewal
- setBidir() : static
- Setter for bidir
- setBlacklistedTerritories() : static
- Setter for blacklistedTerritories
- setCommunicationEndTime() : static
- Setter for communicationEndTime
- setHighPriorityDownlink() : static
- Setter for highPriorityDownlink
- setMaxDownlinkFrames() : static
- Setter for maxDownlinkFrames
- setMaxTokens() : static
- Setter for maxTokens
- setMaxUplinkFrames() : static
- Setter for maxUplinkFrames
- setName() : static
- Setter for name
- setOptions() : static
- Setter for options
- setOrderName() : static
- Setter for orderName
- setRenewalDuration() : static
- Setter for renewalDuration
Properties
$activationEndTime
The activation end time (in milliseconds) of the contract. 0 means no activation time limit.
protected
int|null
$activationEndTime
= null
$automaticRenewal
True if automatic renewal is allowed.
protected
bool|null
$automaticRenewal
= null
$bidir
True if the contract info is bidirectional.
protected
bool|null
$bidir
= null
$blacklistedTerritories
The list of "blacklisted" territories, as an array of NIP group IDs.
protected
array<string|int, mixed>|null
$blacklistedTerritories
= null
$communicationEndTime
The end time (in milliseconds) of the communication. 0 means no communication time limit.
protected
int|null
$communicationEndTime
= null
$highPriorityDownlink
True if all downlinks are high priority.
protected
bool|null
$highPriorityDownlink
= null
$maxDownlinkFrames
The maximum number of downlink frames.
protected
int|null
$maxDownlinkFrames
= null
$maxTokens
The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.
protected
int|null
$maxTokens
= null
$maxUplinkFrames
The maximum number of uplink frames.
protected
int|null
$maxUplinkFrames
= null
$name
The contract name
protected
string|null
$name
= null
$options
The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.
protected
array<string|int, mixed>|null
$options
= null
$orderName
The order name, if any. This field can be unset when updating.
protected
string|null
$orderName
= null
$renewalDuration
The renewal duration in months.
protected
int|null
$renewalDuration
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getActivationEndTime()
Getter for activationEndTime
public
getActivationEndTime() : int
Return values
int —The activation end time (in milliseconds) of the contract. 0 means no activation time limit.
getAutomaticRenewal()
Getter for automaticRenewal
public
getAutomaticRenewal() : bool
Return values
bool —True if automatic renewal is allowed.
getBidir()
Getter for bidir
public
getBidir() : bool
Return values
bool —True if the contract info is bidirectional.
getBlacklistedTerritories()
Getter for blacklistedTerritories
public
getBlacklistedTerritories() : array<string|int, string>
Return values
array<string|int, string> —The list of "blacklisted" territories, as an array of NIP group IDs.
getCommunicationEndTime()
Getter for communicationEndTime
public
getCommunicationEndTime() : int
Return values
int —The end time (in milliseconds) of the communication. 0 means no communication time limit.
getHighPriorityDownlink()
Getter for highPriorityDownlink
public
getHighPriorityDownlink() : bool
Return values
bool —True if all downlinks are high priority.
getMaxDownlinkFrames()
Getter for maxDownlinkFrames
public
getMaxDownlinkFrames() : int
Return values
int —The maximum number of downlink frames.
getMaxTokens()
Getter for maxTokens
public
getMaxTokens() : int
Return values
int —The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.
getMaxUplinkFrames()
Getter for maxUplinkFrames
public
getMaxUplinkFrames() : int
Return values
int —The maximum number of uplink frames.
getName()
Getter for name
public
getName() : string
Return values
string —The contract name
getOptions()
Getter for options
public
getOptions() : array<string|int, OptionsItem>
Return values
array<string|int, OptionsItem> —The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.
getOrderName()
Getter for orderName
public
getOrderName() : string
Return values
string —The order name, if any. This field can be unset when updating.
getRenewalDuration()
Getter for renewalDuration
public
getRenewalDuration() : int
Return values
int —The renewal duration in months.
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setActivationEndTime()
Setter for activationEndTime
public
setActivationEndTime(int $activationEndTime) : static
Parameters
- $activationEndTime : int
-
The activation end time (in milliseconds) of the contract. 0 means no activation time limit.
Return values
static —To use in method chains
setAutomaticRenewal()
Setter for automaticRenewal
public
setAutomaticRenewal(bool $automaticRenewal) : static
Parameters
- $automaticRenewal : bool
-
True if automatic renewal is allowed.
Return values
static —To use in method chains
setBidir()
Setter for bidir
public
setBidir(bool $bidir) : static
Parameters
- $bidir : bool
-
True if the contract info is bidirectional.
Return values
static —To use in method chains
setBlacklistedTerritories()
Setter for blacklistedTerritories
public
setBlacklistedTerritories(array<string|int, string> $blacklistedTerritories) : static
Parameters
- $blacklistedTerritories : array<string|int, string>
-
The list of "blacklisted" territories, as an array of NIP group IDs.
Return values
static —To use in method chains
setCommunicationEndTime()
Setter for communicationEndTime
public
setCommunicationEndTime(int $communicationEndTime) : static
Parameters
- $communicationEndTime : int
-
The end time (in milliseconds) of the communication. 0 means no communication time limit.
Return values
static —To use in method chains
setHighPriorityDownlink()
Setter for highPriorityDownlink
public
setHighPriorityDownlink(bool $highPriorityDownlink) : static
Parameters
- $highPriorityDownlink : bool
-
True if all downlinks are high priority.
Return values
static —To use in method chains
setMaxDownlinkFrames()
Setter for maxDownlinkFrames
public
setMaxDownlinkFrames(int $maxDownlinkFrames) : static
Parameters
- $maxDownlinkFrames : int
-
The maximum number of downlink frames.
Return values
static —To use in method chains
setMaxTokens()
Setter for maxTokens
public
setMaxTokens(int $maxTokens) : static
Parameters
- $maxTokens : int
-
The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.
Return values
static —To use in method chains
setMaxUplinkFrames()
Setter for maxUplinkFrames
public
setMaxUplinkFrames(int $maxUplinkFrames) : static
Parameters
- $maxUplinkFrames : int
-
The maximum number of uplink frames.
Return values
static —To use in method chains
setName()
Setter for name
public
setName(string $name) : static
Parameters
- $name : string
-
The contract name
Return values
static —To use in method chains
setOptions()
Setter for options
public
setOptions(array<string|int, OptionsItem> $options) : static
Parameters
- $options : array<string|int, OptionsItem>
-
The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.
Return values
static —To use in method chains
setOrderName()
Setter for orderName
public
setOrderName(string $orderName) : static
Parameters
- $orderName : string
-
The order name, if any. This field can be unset when updating.
Return values
static —To use in method chains
setRenewalDuration()
Setter for renewalDuration
public
setRenewalDuration(int $renewalDuration) : static
Parameters
- $renewalDuration : int
-
The renewal duration in months.
Return values
static —To use in method chains