Documentation

Google_Service_HangoutsChat_Resource_SpacesMessages extends Google_Service_Resource
in package

The "messages" collection of methods.

Typical usage is: $chatService = new Google_Service_HangoutsChat(...); $messages = $chatService->messages;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_HangoutsChat_Message
Creates a message. (messages.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_HangoutsChat_ChatEmpty
Deletes a message. (messages.delete)
get()  : Google_Service_HangoutsChat_Message
Returns a message. (messages.get)
update()  : Google_Service_HangoutsChat_Message
Updates a message. (messages.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a message. (messages.create)

public create(string $parent, Google_Service_HangoutsChat_Message $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_HangoutsChat_Message
Parameters
$parent : string

Required. Space resource name, in the form "spaces". Example: spaces/AAAAMpdlehY

$postBody : Google_Service_HangoutsChat_Message
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string threadKey Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.

Return values
Google_Service_HangoutsChat_Message —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a message. (messages.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_HangoutsChat_ChatEmpty
Parameters
$name : string

Required. Resource name of the message to be deleted, in the form "spaces/messages" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_HangoutsChat_ChatEmpty —

get()

Returns a message. (messages.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_HangoutsChat_Message
Parameters
$name : string

Required. Resource name of the message to be retrieved, in the form "spaces/messages". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_HangoutsChat_Message —

update()

Updates a message. (messages.update)

public update(string $name, Google_Service_HangoutsChat_Message $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_HangoutsChat_Message
Parameters
$name : string

Resource name, in the form "spaces/messages". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4

$postBody : Google_Service_HangoutsChat_Message
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: * text * cards

Return values
Google_Service_HangoutsChat_Message —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results