CommunicationChannel

google.cloud.irm.v1alpha2. CommunicationChannel

Represents a CommunicationChannel.

Constructor

new CommunicationChannel(propertiesopt)

Constructs a new CommunicationChannel.

Parameters:
Name Type Attributes Description
properties google.cloud.irm.v1alpha2.ICommunicationChannel <optional>

Properties to set
Implements:
  • ICommunicationChannel

Classes

Email
NotificationChannel

Members

email :google.cloud.irm.v1alpha2.CommunicationChannel.IEmail|null|undefined

CommunicationChannel email.

endpoint :"email"|"notificationChannel"|undefined

CommunicationChannel endpoint.

notificationChannel :google.cloud.irm.v1alpha2.CommunicationChannel.INotificationChannel|null|undefined

CommunicationChannel notificationChannel.

Methods

(static) create(propertiesopt) → {google.cloud.irm.v1alpha2.CommunicationChannel}

Creates a new CommunicationChannel instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.irm.v1alpha2.ICommunicationChannel <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.irm.v1alpha2.CommunicationChannel}

Decodes a CommunicationChannel message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.irm.v1alpha2.CommunicationChannel}

Decodes a CommunicationChannel message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CommunicationChannel message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.ICommunicationChannel

CommunicationChannel message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified CommunicationChannel message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.ICommunicationChannel

CommunicationChannel message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.irm.v1alpha2.CommunicationChannel}

Creates a CommunicationChannel message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a CommunicationChannel message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.CommunicationChannel

CommunicationChannel
options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a CommunicationChannel message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this CommunicationChannel to JSON.