Subsections of collect

Comms Module Message

This is a base object that allows the user to create a CommsModule.

withAntennaStatus(antennaStatus)

Set the antennaStatus attribute

Parámetros

Nombre Tipo Opcional Descripción
antennaStatus string ❌ optional field

Retorna

Tip

Tipo: CommsModule

withHardware(hardware)

Set the hardware attribute

Parámetros

Nombre Tipo Opcional Descripción
hardware Hardware ❌ optionals field

Retorna

Tip

Tipo: CommsModule

withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ optional field

Retorna

Tip

Tipo: CommsModule

withMobile(mobile)

Set the mobile attribute

Parámetros

Nombre Tipo Opcional Descripción
mobile * ❌

Retorna

Tip

Tipo: CommsModule

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ optional field

Retorna

Tip

Tipo: CommsModule

withOperationalStatus(operationalStatus)

Set the operationalStatus attribute

Parámetros

Nombre Tipo Opcional Descripción
operationalStatus string ❌

Retorna

Tip

Tipo: CommsModule

withSoftware(software)

Set the software attribute

Parámetros

Nombre Tipo Opcional Descripción
software * ❌

Retorna

Tip

Tipo: CommsModule

withSubscriber(subscriber)

Set the subscriber attribute

Parámetros

Nombre Tipo Opcional Descripción
subscriber * ❌

Retorna

Tip

Tipo: CommsModule

withSubscription(subscription)

Set the subscription attribute

Parámetros

Nombre Tipo Opcional Descripción
subscription * ❌

Retorna

Tip

Tipo: CommsModule

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌ optional field

Retorna

Tip

Tipo: CommsModule

Datapoint

This is a base object that allows the user to create a Datapoint.

withAt(at)

Sets the at attribute

Parámetros

Nombre Tipo Opcional Descripción
at number ❌ optional field

Retorna

Tip

Tipo: Datapoint

withFrom(from)

Sets the from attribute

Parámetros

Nombre Tipo Opcional Descripción
from number ❌ optional field

Retorna

Tip

Tipo: Datapoint

withSource(value)

Sets the source attribute

Parámetros

Nombre Tipo Opcional Descripción
value string ❌ optional field

Retorna

Tip

Tipo: Datapoint

withSourceInfo(value)

Sets the source attribute

Parámetros

Nombre Tipo Opcional Descripción
value string ❌ optional field

Retorna

Tip

Tipo: Datapoint

withTags(tags)

Sets the tags attribute

Parámetros

Nombre Tipo Opcional Descripción
tags Array ❌

Retorna

Tip

Tipo: Datapoint

withValue(value)

Sets the value attribute

Parámetros

Nombre Tipo Opcional Descripción
value string ❌ required field

Retorna

Tip

Tipo: Datapoint

Datastream

This is a base object that allows the user to create a Datastream.

withDatapoint(datapoint)

Add a datapoint in datapoints

Parámetros

Nombre Tipo Opcional Descripción
datapoint Datapoint ❌ required field

Retorna

Tip

Tipo: Datastream

withFeed(feed)

Set the feed attribute

Parámetros

Nombre Tipo Opcional Descripción
feed string ❌ optionals field

Retorna

Tip

Tipo: Datastream

withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Datastream

Event

This is a base object that allows the user to create a Event.

withCommsModule(communicationsModules)

Set the powerSupply attribute

Parámetros

Nombre Tipo Opcional Descripción
communicationsModules * ❌

Retorna

Tip

Tipo: Event

withCpuUsage(cpuUsage)

Set the cpuUsage attribute

Parámetros

Nombre Tipo Opcional Descripción
cpuUsage * ❌

Retorna

Tip

Tipo: Event

withCurrentTemperature(currentTemperature)

Set the currentTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
currentTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withDateLocation(date)

Set the date attribute

Parámetros

Nombre Tipo Opcional Descripción
date string ❌ optionals field

Retorna

Tip

Tipo: Event

withDeviceId(deviceId)

Set the deviceId attribute

Parámetros

Nombre Tipo Opcional Descripción
deviceId string ❌ optionals field

Retorna

Tip

Tipo: Event

withEventDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ optionals field

Retorna

Tip

Tipo: Event

withEventId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ optionals field

Retorna

Tip

Tipo: Event

withEventName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ optionals field

Retorna

Tip

Tipo: Event

withHardware(hardware)

Set the hardware attribute

Parámetros

Nombre Tipo Opcional Descripción
hardware Hardware ❌ optionals field

Retorna

Tip

Tipo: Event

withLatitude(latitude)

Set the latitude attribute

Parámetros

Nombre Tipo Opcional Descripción
latitude number ❌ optionals field

Retorna

Tip

Tipo: Event

withLongitude(longitude)

Set the longitude attribute

Parámetros

Nombre Tipo Opcional Descripción
longitude number ❌ optionals field

Retorna

Tip

Tipo: Event

withMaximumTemperature(maximumTemperature)

Set the maximum attribute

Parámetros

Nombre Tipo Opcional Descripción
maximumTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withMinimumTemperature(minimumTemperature)

Set the minimum attribute

Parámetros

Nombre Tipo Opcional Descripción
minimumTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withNonVolatilStorage(nonVolatilStorage)

Set the nonVolatilStorage attribute

Parámetros

Nombre Tipo Opcional Descripción
nonVolatilStorage * ❌

Retorna

Tip

Tipo: Event

withOperationalStatus(operationalStatus)

Set the operationalStatus attribute

Parámetros

Nombre Tipo Opcional Descripción
operationalStatus string ❌

Retorna

Tip

Tipo: Event

withPath(path)

Set the path attribute

Parámetros

Nombre Tipo Opcional Descripción
path string ❌ optionals field

Retorna

Tip

Tipo: Event

withPowerSupply(powerSupply)

Set the powerSupply attribute

Parámetros

Nombre Tipo Opcional Descripción
powerSupply * ❌

Retorna

Tip

Tipo: Event

withRam(ram)

Set the Ram attribute

Parámetros

Nombre Tipo Opcional Descripción
ram * ❌

Retorna

Tip

Tipo: Event

withSoftware(software)

Set the software attribute

Parámetros

Nombre Tipo Opcional Descripción
software software ❌ optionals field

Retorna

Tip

Tipo: Event

withStatusTemperature(unitTemperature)

Set the unitTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
unitTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withTemperatureAverage(averageTemperature)

Set the average attribute

Parámetros

Nombre Tipo Opcional Descripción
averageTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withTrendTemperature(unitTemperature)

Set the unitTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
unitTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withUnitTemperature(unitTemperature)

Set the unitTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
unitTemperature string ❌ optionals field

Retorna

Tip

Tipo: Event

withUpTime(upTime)

Set the upTime attribute

Parámetros

Nombre Tipo Opcional Descripción
upTime number ❌

Retorna

Tip

Tipo: Event

withVolatilStorage(volatilStorage)

Set the volatilStorage attribute

Parámetros

Nombre Tipo Opcional Descripción
volatilStorage * ❌

Retorna

Tip

Tipo: Event

Hardware

This is a base object that allows the user to create a Datapoint.

withClockDate(clockDate)

Set the clockDate attribute

Parámetros

Nombre Tipo Opcional Descripción
clockDate string ❌

Retorna

Tip

Tipo: Hardware

withManufacturerName(manufacturerName)

Set the manufacturerName attribute

Parámetros

Nombre Tipo Opcional Descripción
manufacturerName string ❌

Retorna

Tip

Tipo: Hardware

withManufacturerOui(manufacturerOui)

Set the manufacturerOui attribute

Parámetros

Nombre Tipo Opcional Descripción
manufacturerOui string ❌

Retorna

Tip

Tipo: Hardware

withModelName(modelName)

Set the modelName attribute

Parámetros

Nombre Tipo Opcional Descripción
modelName string ❌

Retorna

Tip

Tipo: Hardware

withModelVersion(modelVersion)

Set the modelVersion attribute

Parámetros

Nombre Tipo Opcional Descripción
modelVersion string ❌

Retorna

Tip

Tipo: Hardware

withSerialnumber(serialnumber)

Set the serialnumber attribute

Parámetros

Nombre Tipo Opcional Descripción
serialnumber string ❌

Retorna

Tip

Tipo: Hardware

Location

This is a base object that allows the user to create a Datapoint.

withDateLocation(date)

Set the date attribute

Parámetros

Nombre Tipo Opcional Descripción
date string ❌ optionals field

Retorna

Tip

Tipo: Location

withLatitude(latitude)

Set the latitude attribute

Parámetros

Nombre Tipo Opcional Descripción
latitude number ❌ optionals field

Retorna

Tip

Tipo: Location

withLongitude(longitude)

Set the longitude attribute

Parámetros

Nombre Tipo Opcional Descripción
longitude number ❌ optionals field

Retorna

Tip

Tipo: Location

Mobile

This is a base object that allows the user to create a Datapoint.

withApn(apn)

Set the apn attribute

Parámetros

Nombre Tipo Opcional Descripción
apn string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withBcch(bcch)

Set the bcch attribute

Parámetros

Nombre Tipo Opcional Descripción
bcch string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withCellId(cellId)

Set the cellId attribute

Parámetros

Nombre Tipo Opcional Descripción
cellId string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withCgi(cgi)

Set the cgi attribute

Parámetros

Nombre Tipo Opcional Descripción
cgi string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withLac(lac)

Set the lac attribute

Parámetros

Nombre Tipo Opcional Descripción
lac string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withMr(mr)

Set the mr attribute

Parámetros

Nombre Tipo Opcional Descripción
mr string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withPlmn(plmn)

Set the plmn attribute

Parámetros

Nombre Tipo Opcional Descripción
plmn string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withRatType(ratType)

Set the ratType attribute

Parámetros

Nombre Tipo Opcional Descripción
ratType string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withsignalQuality(signalQuality)

Set the signalQuality attribute

Parámetros

Nombre Tipo Opcional Descripción
signalQuality string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withsignalQualityMax(signalQualityMax)

Set the signalQualityMax attribute

Parámetros

Nombre Tipo Opcional Descripción
signalQualityMax string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withsignalQualityMin(signalQualityMin)

Set the signalQualityMin attribute

Parámetros

Nombre Tipo Opcional Descripción
signalQualityMin string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withSignalStrength(signalStrength)

Set the signalStrength attribute

Parámetros

Nombre Tipo Opcional Descripción
signalStrength string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withSignalStrengthMax(signalStrengthMax)

Set the signalStrengthMax attribute

Parámetros

Nombre Tipo Opcional Descripción
signalStrengthMax string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withsignalStrengthMin(signalStrengthMin)

Set the signalStrengthMin attribute

Parámetros

Nombre Tipo Opcional Descripción
signalStrengthMin string ❌ optionals field

Retorna

Tip

Tipo: Mobile

withTimingAdvance(timingAdvance)

Set the timingAdvance attribute

Parámetros

Nombre Tipo Opcional Descripción
timingAdvance string ❌ optionals field

Retorna

Tip

Tipo: Mobile

Power Supply

This is a base object that allows the user to create a Datapoint.

withBatteryChargeLevelPercentage(percentage)

Set the BatteryChargeLevel percentage attribute

Parámetros

Nombre Tipo Opcional Descripción
percentage string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withBatteryChargeLevelStatus(status)

Set the battery status attribute

Parámetros

Nombre Tipo Opcional Descripción
status string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withBatteryChargeLevelTrend(trend)

Set the trend attribute

Parámetros

Nombre Tipo Opcional Descripción
trend string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withOutageDate(outageDate)

Set the OutageDate attribute

Parámetros

Nombre Tipo Opcional Descripción
outageDate string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withOutageDuration(duration)

Set the duration attribute

Parámetros

Nombre Tipo Opcional Descripción
duration number ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withSource(source)

Set the source attribute

Parámetros

Nombre Tipo Opcional Descripción
source string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

withStatus(status)

Set the status attribute

Parámetros

Nombre Tipo Opcional Descripción
status string ❌ optionals field

Retorna

Tip

Tipo: PowerSupply

Software

This is a base object that allows the user to create a Datapoint.

withDate(date)

Set the date attribute

Parámetros

Nombre Tipo Opcional Descripción
date string ❌

Retorna

Tip

Tipo: Software

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌

Retorna

Tip

Tipo: Software

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌

Retorna

Tip

Tipo: Software

withVersion(version)

Set the version attribute

Parámetros

Nombre Tipo Opcional Descripción
version string ❌

Retorna

Tip

Tipo: Software

Storage

This is a base object that allows the user to create a Datapoint.

withTotal(total)

Set the total attribute

Parámetros

Nombre Tipo Opcional Descripción
total string ❌ optionals field

Retorna

Tip

Tipo: Storage

withUnit(unit)

Set the unit attribute

Parámetros

Nombre Tipo Opcional Descripción
unit string ❌ optionals field

Retorna

Tip

Tipo: Storage

Subscriber

This is a base object that allows the user to create a Subscription.

withHardware(hardware)

Set the hardware attribute

Parámetros

Nombre Tipo Opcional Descripción
hardware Hardware ❌ optionals field

Retorna

Tip

Tipo: Subscriber

withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ optional field

Retorna

Tip

Tipo: Subscriber

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ optional field

Retorna

Tip

Tipo: Subscriber

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌ optional field

Retorna

Tip

Tipo: Subscriber

Subscription

This is a base object that allows the user to create a Subscription.

withAddressApn(addressApn)

Set the addressApn attribute

Parámetros

Nombre Tipo Opcional Descripción
addressApn string ❌ optional field

Retorna

Tip

Tipo: Subscription

withAddressType(addressType)

Set the addressType attribute

Parámetros

Nombre Tipo Opcional Descripción
addressType string ❌ optional field

Retorna

Tip

Tipo: Subscription

withAddressValue(addressValue)

Set the addressValue attribute

Parámetros

Nombre Tipo Opcional Descripción
addressValue string ❌ optional field

Retorna

Tip

Tipo: Subscription

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ optional field

Retorna

Tip

Tipo: Subscription

withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ optional field

Retorna

Tip

Tipo: Subscription

withImsi(imsi)

Set the imsi attribute

Parámetros

Nombre Tipo Opcional Descripción
imsi string ❌ optional field

Retorna

Tip

Tipo: Subscription

withMsisdn(msisdn)

Set the msisdn attribute

Parámetros

Nombre Tipo Opcional Descripción
msisdn string ❌ optional field

Retorna

Tip

Tipo: Subscription

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ optional field

Retorna

Tip

Tipo: Subscription

withOperator(operator)

Set the operator attribute

Parámetros

Nombre Tipo Opcional Descripción
operator string ❌ optional field

Retorna

Tip

Tipo: Subscription

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌ optional field

Retorna

Tip

Tipo: Subscription

Temperature

This is a base object that allows the user to create a Datapoint.

withCurrentTemperature(currentTemperature)

Set the currentTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
currentTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withMaximumTemperature(maximumTemperature)

Set the maximum attribute

Parámetros

Nombre Tipo Opcional Descripción
maximumTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withMinimumTemperature(minimumTemperature)

Set the minimumTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
minimumTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withStatusTemperature(statusTemperature)

Set the statusTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
statusTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withTemperatureAverage(averageTemperature)

Set the averageTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
averageTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withTrendTemperature(trendTemperature)

Set the trendTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
trendTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

withUnitTemperature(unitTemperature)

Set the unitTemperature attribute

Parámetros

Nombre Tipo Opcional Descripción
unitTemperature string ❌ optionals field

Retorna

Tip

Tipo: Temperature

Usage

This is a base object that allows the user to create a Datapoint.

withAverage(average)

Set the average attribute

Parámetros

Nombre Tipo Opcional Descripción
average string ❌ optionals field

Retorna

Tip

Tipo: Usage

withCurrent(current)

Set the current attribute

Parámetros

Nombre Tipo Opcional Descripción
current string ❌ optionals field

Retorna

Tip

Tipo: Usage

withMaximum(maximum)

Set the maximum attribute

Parámetros

Nombre Tipo Opcional Descripción
maximum string ❌ optionals field

Retorna

Tip

Tipo: Usage

withMinimum(minimum)

Set the minimum attribute

Parámetros

Nombre Tipo Opcional Descripción
minimum string ❌ optionals field

Retorna

Tip

Tipo: Usage

withUsageUnit(unit)

Set the unit attribute

Parámetros

Nombre Tipo Opcional Descripción
unit string ❌ optionals field

Retorna

Tip

Tipo: Usage