import CommsModuleMessage from 'opengate-js/src/collection/devices/collect/CommsModuleMessage.js'

public class | source

CommsModuleMessage

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

Constructor Summary

Public Constructor
public	constructor(ogapi: *)

Method Summary

Public Methods
public	composeElement(): *
public	withAntennaStatus(antennaStatus: string): CommsModule Set the antennaStatus attribute
public	withHardware(hardware: Hardware): CommsModule Set the hardware attribute
public	withId(id: string): CommsModule Set the id attribute
public	withMobile(mobile: *): CommsModule Set the mobile attribute
public	withName(name: string): CommsModule Set the name attribute
public	withOperationalStatus(operationalStatus: string): CommsModule Set the operationalStatus attribute
public	withSoftware(software: *): CommsModule Set the software attribute
public	withSubscriber(subscriber: *): CommsModule Set the subscriber attribute
public	withSubscription(subscription: *): CommsModule Set the subscription attribute
public	withType(type: string): CommsModule Set the type attribute

Public Constructors

public constructor(ogapi: *) source

Params:

Name	Type	Attribute	Description
ogapi	*

Public Methods

public composeElement(): * source

Return:

public withAntennaStatus(antennaStatus: string): CommsModule source

Set the antennaStatus attribute

Params:

Name	Type	Attribute	Description
antennaStatus	string		optional field

Return:

CommsModule

public withHardware(hardware: Hardware): CommsModule source

Set the hardware attribute

Params:

Name	Type	Attribute	Description
hardware	Hardware		optionals field

Return:

CommsModule

public withId(id: string): CommsModule source

Set the id attribute

Params:

Name	Type	Attribute	Description
id	string		optional field

Return:

CommsModule

public withMobile(mobile: *): CommsModule source

Set the mobile attribute

Params:

Name	Type	Attribute	Description
mobile	*

Return:

CommsModule

public withName(name: string): CommsModule source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		optional field

Return:

CommsModule

public withOperationalStatus(operationalStatus: string): CommsModule source

Set the operationalStatus attribute

Params:

Name	Type	Attribute	Description
operationalStatus	string

Return:

CommsModule

public withSoftware(software: *): CommsModule source

Set the software attribute

Params:

Name	Type	Attribute	Description
software	*

Return:

CommsModule

public withSubscriber(subscriber: *): CommsModule source

Set the subscriber attribute

Params:

Name	Type	Attribute	Description
subscriber	*

Return:

CommsModule

public withSubscription(subscription: *): CommsModule source

Set the subscription attribute

Params:

Name	Type	Attribute	Description
subscription	*

Return:

CommsModule

public withType(type: string): CommsModule source

Set the type attribute

Params:

Name	Type	Attribute	Description
type	string		optional field

Return:

CommsModule