com.kintone.client

Class SpaceClient

Object

SpaceClient

public class SpaceClient
extends Object

A client that operates space APIs.

Method Summary

Modifier and Type	Method and Description
AddGuestsResponseBody	addGuests(AddGuestsRequest request) Adds Guest users to kintone.
void	addGuests(List<GuestUser> guests) Adds Guest users to kintone.
AddSpaceFromTemplateResponseBody	addSpaceFromTemplate(AddSpaceFromTemplateRequest request) Creates a Space from a Space template.
AddThreadResponseBody	addThread(AddThreadRequest request) Adds a Thread in a Space.
long	addThread(long spaceId, String name) Adds a Thread in a Space.
AddThreadCommentResponseBody	addThreadComment(AddThreadCommentRequest request) Adds a comment to a Thread of a Space.
long	addThreadComment(long spaceId, long threadId, ThreadComment comment) Adds a comment to a Thread of a Space.
DeleteGuestsResponseBody	deleteGuests(DeleteGuestsRequest request) Deletes a Guest user from kintone.
void	deleteGuests(List<String> guests) Deletes a Guest user from kintone.
DeleteSpaceResponseBody	deleteSpace(DeleteSpaceRequest request) Deletes a Space.
void	deleteSpace(long spaceId) Deletes a Space.
GetSpaceResponseBody	getSpace(GetSpaceRequest request) Gets information of a Space.
GetSpaceResponseBody	getSpace(long spaceId) Gets information of a Space.
GetSpaceMembersResponseBody	getSpaceMembers(GetSpaceMembersRequest request) Gets the list of Space members of a Space.
List<AddedSpaceMember>	getSpaceMembers(long spaceId) Gets the list of Space members of a Space.
GetSpacesStatisticsResponseBody	getStatistics() Gets space usage statistics.
GetSpacesStatisticsResponseBody	getStatistics(GetSpacesStatisticsRequest request) Gets space usage statistics.
UpdateSpaceResponseBody	updateSpace(UpdateSpaceRequest request) Updates the settings of a Space.
void	updateSpaceBody(long spaceId, String body) Updates the body of a Space.
UpdateSpaceBodyResponseBody	updateSpaceBody(UpdateSpaceBodyRequest request) Updates the body of a Space.
void	updateSpaceGuests(long spaceId, List<String> guests) Updates the Guest members of a Space.
UpdateSpaceGuestsResponseBody	updateSpaceGuests(UpdateSpaceGuestsRequest request) Updates the Guest members of a Space.
void	updateSpaceMembers(long spaceId, List<SpaceMember> members) Updates the members of a Space.
UpdateSpaceMembersResponseBody	updateSpaceMembers(UpdateSpaceMembersRequest request) Updates the Members of a Space.
void	updateThread(long threadId, String name, String body) Updates a Thread of a Space.
UpdateThreadResponseBody	updateThread(UpdateThreadRequest request) Updates a Thread of a Space.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addGuests

public void addGuests(List<GuestUser> guests)

Adds Guest users to kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, follow up this API call with the Update Space Guests API.

Parameters:

guests - the list of Guest user data

addGuests

public AddGuestsResponseBody addGuests(AddGuestsRequest request)

Adds Guest users to kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user with a Guest Space, follow up this API call with the Update Space Guests API.

Parameters:

request - the request parameters. See AddGuestsRequest

Returns:

the response data. See AddGuestsResponseBody

addSpaceFromTemplate

public AddSpaceFromTemplateResponseBody addSpaceFromTemplate(AddSpaceFromTemplateRequest request)

Creates a Space from a Space template.

Parameters:

request - the request parameters. See AddSpaceFromTemplateRequest

Returns:

the response data. See AddSpaceFromTemplateResponseBody

addThread

public long addThread(long spaceId,
                      String name)

Adds a Thread in a Space.

Parameters:

spaceId - the Space ID

name - the name of the new Thread

Returns:

the Thread ID of the created Thread

addThread

public AddThreadResponseBody addThread(AddThreadRequest request)

Adds a Thread in a Space.

Parameters:

request - the request parameters. See AddThreadRequest

Returns:

the response data. See AddThreadResponseBody

addThreadComment

public long addThreadComment(long spaceId,
                             long threadId,
                             ThreadComment comment)

Adds a comment to a Thread of a Space.

Parameters:

spaceId - the Space ID

threadId - the Thread ID

comment - An object including comment details

Returns:

the comment ID of the created comment

addThreadComment

public AddThreadCommentResponseBody addThreadComment(AddThreadCommentRequest request)

Adds a comment to a Thread of a Space.

Parameters:

request - the request parameters. See AddThreadCommentRequest

Returns:

the response data. See AddThreadCommentResponseBody

deleteGuests

public void deleteGuests(List<String> guests)

Deletes a Guest user from kintone. If you would like to remove a user from a Guest Space without deleting their account, use the Update Guest Members API.

Parameters:

guests - a list of email addresses of Guest users

deleteGuests

public DeleteGuestsResponseBody deleteGuests(DeleteGuestsRequest request)

Deletes a Guest user from kintone. If you would like to remove a user from a Guest Space without deleting their account, use the Update Guest Members API.

Parameters:

request - the request parameters. See DeleteGuestsRequest

Returns:

the response data. See DeleteGuestsResponseBody

deleteSpace

public void deleteSpace(long spaceId)

Deletes a Space.

Parameters:

spaceId - the Space ID

deleteSpace

public DeleteSpaceResponseBody deleteSpace(DeleteSpaceRequest request)

Deletes a Space.

Parameters:

request - the request parameters. See DeleteSpaceRequest

Returns:

the response data. See DeleteSpaceResponseBody

getSpace

public GetSpaceResponseBody getSpace(long spaceId)

Gets information of a Space.

Parameters:

spaceId - ths Space ID

Returns:

the response data. See GetSpaceResponseBody

getSpace

public GetSpaceResponseBody getSpace(GetSpaceRequest request)

Gets information of a Space.

Parameters:

request - the request parameters. See GetSpaceRequest

Returns:

the response data. See GetSpaceResponseBody

getStatistics

public GetSpacesStatisticsResponseBody getStatistics()

Gets space usage statistics.

Returns:

the response data. See GetSpacesStatisticsResponseBody

getStatistics

public GetSpacesStatisticsResponseBody getStatistics(GetSpacesStatisticsRequest request)

Gets space usage statistics.

Parameters:

request - the request parameters. See GetSpacesStatisticsRequest

Returns:

the response data. See GetSpacesStatisticsResponseBody

getSpaceMembers

public List<AddedSpaceMember> getSpaceMembers(long spaceId)

Gets the list of Space members of a Space.

Parameters:

spaceId - the Space ID

Returns:

a list of Space members. Guest users, inactive users and deleted users will not be included.

getSpaceMembers

public GetSpaceMembersResponseBody getSpaceMembers(GetSpaceMembersRequest request)

Gets the list of Space members of a Space.

Parameters:

request - the request parameters. See GetSpaceMembersRequest

Returns:

the response data. See GetSpaceMembersResponseBody

updateSpace

public UpdateSpaceResponseBody updateSpace(UpdateSpaceRequest request)

Updates the settings of a Space.

Parameters:

request - the request parameters. See UpdateSpaceRequest

Returns:

the response data. See UpdateSpaceResponseBody

updateSpaceBody

public void updateSpaceBody(long spaceId,
                            String body)

Updates the body of a Space.

Parameters:

spaceId - the Space ID

body - the contents of the body as an HTML string

updateSpaceBody

public UpdateSpaceBodyResponseBody updateSpaceBody(UpdateSpaceBodyRequest request)

Updates the body of a Space.

Parameters:

request - the request parameters. See UpdateSpaceBodyRequest

Returns:

the response data. See UpdateSpaceBodyResponseBody

updateSpaceGuests

public void updateSpaceGuests(long spaceId,
                              List<String> guests)

Updates the Guest members of a Space.

Parameters:

spaceId - the Space ID

guests - a list of email addresses of Guest users

updateSpaceGuests

public UpdateSpaceGuestsResponseBody updateSpaceGuests(UpdateSpaceGuestsRequest request)

Updates the Guest members of a Space.

Parameters:

request - the request parameters. See UpdateSpaceGuestsRequest

Returns:

the response data. See UpdateSpaceGuestsResponseBody

updateSpaceMembers

public void updateSpaceMembers(long spaceId,
                               List<SpaceMember> members)

Updates the members of a Space.

Parameters:

spaceId - the Space ID

members - a list of members of the Space

updateSpaceMembers

public UpdateSpaceMembersResponseBody updateSpaceMembers(UpdateSpaceMembersRequest request)

Updates the Members of a Space.

Parameters:

request - the request parameters. See UpdateSpaceMembersRequest

Returns:

the response data. See UpdateSpaceMembersResponseBody

updateThread

public void updateThread(long threadId,
                         String name,
                         String body)

Updates a Thread of a Space.

Parameters:

threadId - the Thread ID

name - the new name of the Thread

body - the contents of the Thread body

updateThread

public UpdateThreadResponseBody updateThread(UpdateThreadRequest request)

Updates a Thread of a Space.

Parameters:

request - the request parameters. See UpdateThreadRequest

Returns:

the response data. See UpdateThreadResponseBody