Represents a Comment.
Package
@google-cloud/supportConstructors
(constructor)(properties)
constructor(properties?: google.cloud.support.v2.IComment);
Constructs a new Comment.
Parameter | |
---|---|
Name | Description |
properties |
IComment
Properties to set |
Properties
body
public body: string;
Comment body.
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Comment createTime.
creator
public creator?: (google.cloud.support.v2.IActor|null);
Comment creator.
name
public name: string;
Comment name.
plainTextBody
public plainTextBody: string;
Comment plainTextBody.
Methods
create(properties)
public static create(properties?: google.cloud.support.v2.IComment): google.cloud.support.v2.Comment;
Creates a new Comment instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IComment
Properties to set |
Returns | |
---|---|
Type | Description |
Comment | Comment instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.support.v2.Comment;
Decodes a Comment message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Comment | Comment |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.support.v2.Comment;
Decodes a Comment message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Comment | Comment |
encode(message, writer)
public static encode(message: google.cloud.support.v2.IComment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Comment message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IComment
Comment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.support.v2.IComment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Comment message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IComment
Comment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.support.v2.Comment;
Creates a Comment message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
Comment | Comment |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Comment
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Comment to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.support.v2.Comment, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Comment message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Comment
Comment |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Comment message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|