public static final class ChatServiceGrpc.ChatServiceBlockingStub extends AbstractBlockingStub<ChatServiceGrpc.ChatServiceBlockingStub>
A stub to allow clients to do 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(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)
createMembership(CreateMembershipRequest request)
public Membership createMembership(CreateMembershipRequest request)
Creates a human membership or app membership for the calling app. Creating
memberships for other apps isn't supported. For an example, see
Invite or add a user or a Google Chat app to a
space.
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. Requires user
authentication.
To specify the member to add, set the membership.member.name for the
human or app member, or set the membership.group_member.name for the
group member.
- To add the calling app to a space or a direct message between two human
users, use
users/app. Unable to add other
apps to the space.
- 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 add or invite a Google group in a named space, 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 or invite the group to a named 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.
createMessage(CreateMessageRequest request)
public Message createMessage(CreateMessageRequest request)
Creates a message in a Google Chat space. The maximum message size,
including text and cards, is 32,000 bytes. For an example, see Send a
message.
Calling this method requires
authentication
and supports the following authentication types:
- For text messages, user authentication or app authentication are
supported.
- For card messages, only app authentication is supported. (Only Chat apps
can create card messages.)
createReaction(CreateReactionRequest request)
public Reaction createReaction(CreateReactionRequest request)
createSpace(CreateSpaceRequest request)
public Space createSpace(CreateSpaceRequest request)
Creates a named space. Spaces grouped by topics aren't supported. 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.
Requires user
authentication.
| Returns |
| Type |
Description |
Space |
|
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.
Requires user
authentication
from a user who has permission to delete the space.
| Returns |
| Type |
Description |
Empty |
|
findDirectMessage(FindDirectMessageRequest request)
public Space findDirectMessage(FindDirectMessageRequest request)
| Returns |
| Type |
Description |
Space |
|
getAttachment(GetAttachmentRequest request)
public Attachment getAttachment(GetAttachmentRequest 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.
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.
getSpaceReadState(GetSpaceReadStateRequest request)
public SpaceReadState getSpaceReadState(GetSpaceReadStateRequest request)
getThreadReadState(GetThreadReadStateRequest request)
public ThreadReadState getThreadReadState(GetThreadReadStateRequest 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. 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.
Requires
authentication.
Supports
app
authentication
and user
authentication.
Lists spaces visible to the caller or authenticated user. Group chats
and DMs aren't listed until the first message is sent.
To list all named spaces by Google Workspace organization, use the
spaces.search()
method using Workspace administrator privileges instead.
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.
Requires
authentication.
Supports
app
authentication
and user
authentication.
When using app authentication, requests can only update messages
created by the calling Chat app.
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.
Requires user
authentication.
| Returns |
| Type |
Description |
Space |
|
updateSpaceReadState(UpdateSpaceReadStateRequest request)
public SpaceReadState updateSpaceReadState(UpdateSpaceReadStateRequest request)
uploadAttachment(UploadAttachmentRequest request)
public UploadAttachmentResponse uploadAttachment(UploadAttachmentRequest request)
