public static final class ChatServiceGrpc.ChatServiceBlockingStub extends AbstractBlockingStub<ChatServiceGrpc.ChatServiceBlockingStub>
A stub to allow clients to do limited synchronous rpc calls to service ChatService.
Enables developers to build Chat apps and
integrations on Google Chat Platform.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
ChatServiceGrpc.ChatServiceBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected ChatServiceGrpc.ChatServiceBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
completeImportSpace(CompleteImportSpaceRequest request)
public CompleteImportSpaceResponse completeImportSpace(CompleteImportSpaceRequest request)
createCustomEmoji(CreateCustomEmojiRequest request)
public CustomEmoji createCustomEmoji(CreateCustomEmojiRequest request)
createMembership(CreateMembershipRequest request)
public Membership createMembership(CreateMembershipRequest request)
Creates a membership for the calling Chat app, a user, or a Google Group.
Creating memberships for other Chat apps isn't supported.
When creating a membership, if the specified member has their auto-accept
policy turned off, then they're invited, and must accept the space
invitation before joining. Otherwise, creating a membership adds the member
directly to the specified space.
Supports the following types of
authentication:
createMessage(CreateMessageRequest request)
public Message createMessage(CreateMessageRequest request)
Creates a message in a Google Chat space. For an example, see Send a
message.
The create() method requires either user
authentication
or app
authentication.
Chat attributes the message sender differently depending on the type of
authentication that you use in your request.
The following image shows how Chat attributes a message when you use app
authentication. Chat displays the Chat app as the message
sender. The content of the message can contain text (text), cards
(cardsV2), and accessory widgets (accessoryWidgets).
!Message sent with app
authentication
The following image shows how Chat attributes a message when you use user
authentication. Chat displays the user as the message sender and attributes
the Chat app to the message by displaying its name. The content of message
can only contain text (text).
!Message sent with user
authentication
The maximum message size, including the message contents, is 32,000 bytes.
For
webhook
requests, the response doesn't contain the full message. The response only
populates the name and thread.name fields in addition to the
information that was in the request.
createReaction(CreateReactionRequest request)
public Reaction createReaction(CreateReactionRequest request)
createSpace(CreateSpaceRequest request)
public Space createSpace(CreateSpaceRequest request)
Creates a space with no members. Can be used to create a named space, or a
group chat in Import mode. For an example, see Create a
space.
If you receive the error message ALREADY_EXISTS when creating
a space, try a different displayName. An existing space within
the Google Workspace organization might already use this display name.
Supports the following types of
authentication:
| Returns |
| Type |
Description |
Space |
|
deleteCustomEmoji(DeleteCustomEmojiRequest request)
public Empty deleteCustomEmoji(DeleteCustomEmojiRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteMembership(DeleteMembershipRequest request)
public Membership deleteMembership(DeleteMembershipRequest request)
deleteMessage(DeleteMessageRequest request)
public Empty deleteMessage(DeleteMessageRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteReaction(DeleteReactionRequest request)
public Empty deleteReaction(DeleteReactionRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteSpace(DeleteSpaceRequest request)
public Empty deleteSpace(DeleteSpaceRequest request)
Deletes a named space. Always performs a cascading delete, which means
that the space's child resources—like messages posted in the space and
memberships in the space—are also deleted. For an example, see
Delete a
space.
Supports the following types of
authentication:
| Returns |
| Type |
Description |
Empty |
|
findDirectMessage(FindDirectMessageRequest request)
public Space findDirectMessage(FindDirectMessageRequest request)
Returns the existing direct message with the specified user. If no direct
message space is found, returns a 404 NOT_FOUND error. For an example,
see
Find a direct message.
With app
authentication,
returns the direct message space between the specified user and the calling
Chat app.
With user
authentication,
returns the direct message space between the specified user and the
authenticated user.
// Supports the following types of
authentication:
| Returns |
| Type |
Description |
Space |
|
getAttachment(GetAttachmentRequest request)
public Attachment getAttachment(GetAttachmentRequest request)
getCustomEmoji(GetCustomEmojiRequest request)
public CustomEmoji getCustomEmoji(GetCustomEmojiRequest request)
getMembership(GetMembershipRequest request)
public Membership getMembership(GetMembershipRequest request)
getMessage(GetMessageRequest request)
public Message getMessage(GetMessageRequest request)
getSpace(GetSpaceRequest request)
public Space getSpace(GetSpaceRequest request)
| Returns |
| Type |
Description |
Space |
|
getSpaceEvent(GetSpaceEventRequest request)
public SpaceEvent getSpaceEvent(GetSpaceEventRequest request)
Returns an event from a Google Chat space. The event
payload
contains the most recent version of the resource that changed. For example,
if you request an event about a new message but the message was later
updated, the server returns the updated Message resource in the event
payload.
Note: The permissionSettings field is not returned in the Space
object of the Space event data for this request.
Requires user
authentication.
To get an event, the authenticated user must be a member of the space.
For an example, see Get details about an
event from a Google Chat
space.
getSpaceNotificationSetting(GetSpaceNotificationSettingRequest request)
public SpaceNotificationSetting getSpaceNotificationSetting(GetSpaceNotificationSettingRequest request)
getSpaceReadState(GetSpaceReadStateRequest request)
public SpaceReadState getSpaceReadState(GetSpaceReadStateRequest request)
getThreadReadState(GetThreadReadStateRequest request)
public ThreadReadState getThreadReadState(GetThreadReadStateRequest request)
listCustomEmojis(ListCustomEmojisRequest request)
public ListCustomEmojisResponse listCustomEmojis(ListCustomEmojisRequest request)
listMemberships(ListMembershipsRequest request)
public ListMembershipsResponse listMemberships(ListMembershipsRequest request)
listMessages(ListMessagesRequest request)
public ListMessagesResponse listMessages(ListMessagesRequest request)
Lists messages in a space that the caller is a member of, including
messages from blocked members and spaces. If you list messages from a
space with no messages, the response is an empty object. When using a
REST/HTTP interface, the response contains an empty JSON object, {}.
For an example, see
List
messages.
Requires user
authentication.
listReactions(ListReactionsRequest request)
public ListReactionsResponse listReactions(ListReactionsRequest request)
listSpaceEvents(ListSpaceEventsRequest request)
public ListSpaceEventsResponse listSpaceEvents(ListSpaceEventsRequest request)
Lists events from a Google Chat space. For each event, the
payload
contains the most recent version of the Chat resource. For example, if you
list events about new space members, the server returns Membership
resources that contain the latest membership details. If new members were
removed during the requested period, the event payload contains an empty
Membership resource.
Requires user
authentication.
To list events, the authenticated user must be a member of the space.
For an example, see List events from a Google Chat
space.
listSpaces(ListSpacesRequest request)
public ListSpacesResponse listSpaces(ListSpacesRequest request)
Lists spaces the caller is a member of. Group chats and DMs aren't listed
until the first message is sent. For an example, see
List
spaces.
Supports the following types of
authentication:
searchSpaces(SearchSpacesRequest request)
public SearchSpacesResponse searchSpaces(SearchSpacesRequest request)
setUpSpace(SetUpSpaceRequest request)
public Space setUpSpace(SetUpSpaceRequest request)
Creates a space and adds specified users to it. The calling user is
automatically added to the space, and shouldn't be specified as a
membership in the request. For an example, see
Set up a space with initial
members.
To specify the human members to add, add memberships with the appropriate
membership.member.name. To add a human user, use users/{user}, where
{user} can be the email address for the user. For users in the same
Workspace organization {user} can also be the id for the person from
the People API, or the id for the user in the Directory API. For example,
if the People API Person profile ID for user@example.com is 123456789,
you can add the user to the space by setting the membership.member.name
to users/user@example.com or users/123456789.
To specify the Google groups to add, add memberships with the
appropriate membership.group_member.name. To add or invite a Google
group, use groups/{group}, where {group} is the id for the group from
the Cloud Identity Groups API. For example, you can use Cloud Identity
Groups lookup
API
to retrieve the ID 123456789 for group email group@example.com, then
you can add the group to the space by setting the
membership.group_member.name to groups/123456789. Group email is not
supported, and Google groups can only be added as members in named spaces.
For a named space or group chat, if the caller blocks, or is blocked
by some members, or doesn't have permission to add some members, then
those members aren't added to the created space.
To create a direct message (DM) between the calling user and another human
user, specify exactly one membership to represent the human user. If
one user blocks the other, the request fails and the DM isn't created.
To create a DM between the calling user and the calling app, set
Space.singleUserBotDm to true and don't specify any memberships. You
can only use this method to set up a DM with the calling app. To add the
calling app as a member of a space or an existing DM between two human
users, see
Invite or add a user or app to a
space.
If a DM already exists between two users, even when one user blocks the
other at the time a request is made, then the existing DM is returned.
Spaces with threaded replies aren't supported. If you receive the error
message ALREADY_EXISTS when setting up a space, try a different
displayName. An existing space within the Google Workspace organization
might already use this display name.
Requires user
authentication.
| Returns |
| Type |
Description |
Space |
|
updateMembership(UpdateMembershipRequest request)
public Membership updateMembership(UpdateMembershipRequest request)
updateMessage(UpdateMessageRequest request)
public Message updateMessage(UpdateMessageRequest request)
Updates a message. There's a difference between the patch and update
methods. The patch
method uses a patch request while the update method uses a put
request. We recommend using the patch method. For an example, see
Update a
message.
Supports the following types of
authentication:
updateSpace(UpdateSpaceRequest request)
public Space updateSpace(UpdateSpaceRequest request)
Updates a space. For an example, see
Update a
space.
If you're updating the displayName field and receive the error message
ALREADY_EXISTS, try a different display name.. An existing space within
the Google Workspace organization might already use this display name.
Supports the following types of
authentication:
| Returns |
| Type |
Description |
Space |
|
updateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest request)
public SpaceNotificationSetting updateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest request)
updateSpaceReadState(UpdateSpaceReadStateRequest request)
public SpaceReadState updateSpaceReadState(UpdateSpaceReadStateRequest request)
uploadAttachment(UploadAttachmentRequest request)
public UploadAttachmentResponse uploadAttachment(UploadAttachmentRequest request)
