get method

Future<CustomEmoji> get(
  1. String name, {
  2. String? $fields,
})

Returns details about a custom emoji.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.customemojis.readonly - https://www.googleapis.com/auth/chat.customemojis

Request parameters:

name - Required. Resource name of the custom emoji. Format: customEmojis/{customEmoji} You can use the emoji name as an alias for {customEmoji}. For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji. Value must have pattern ^customEmojis/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a CustomEmoji.

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<CustomEmoji> 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 CustomEmoji.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}