get method
Returns details about a message.
For an example, see Read a message. Requires authentication. Supports app authentication and user authentication. Note: Might return a message from a blocked member or space.
Request parameters:
name
- Required. Resource name of the message to retrieve. Format:
spaces/{space}/messages/{message}
If the message begins with client-
,
then it has a custom name assigned by a Chat app that created it with the
Chat REST API. That Chat app (but not others) can pass the custom name to
get, update, or delete the message. To learn more, see
create and name a message.
Value must have pattern ^spaces/\[^/\]+/messages/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Message.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<Message> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Message.fromJson(response_ as core.Map<core.String, core.dynamic>);
}