Organization Plans
This is a base object that contains everything you can do with organization plans.
constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
withFlowRate(flowRate)
Set the flowRate attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| flowRate | object |
❌ | {value: number, unit: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]} |
Retorna
Tip
Tipo: OrganizationPlans
withIdentifier(identifier)
Set the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ | required field |
Retorna
Tip
Tipo: OrganizationPlans
withMaxDeviceAmount(maxDeviceAmount)
Set the maxDeviceAmount attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| maxDeviceAmount | object |
❌ | optional and greater than 0 |
Retorna
Tip
Tipo: OrganizationPlans
withMaxStorageLifeTime(maxStorageLifeTime)
Set the maxStorageLifeTime attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| maxStorageLifeTime | object |
❌ | required field: {total: number, period: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]} |
Retorna
Tip
Tipo: OrganizationPlans
withName(name)
Set the name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: OrganizationPlans