The Communote Client for Java provides functionality to authentificate to communote and to access resources. Furthermore he contains java representations of resources.
Here are some important informations to use the Communote Client as an dependency in applications.

Please note that the Communote Client for Java has only development status! So we not guarantee for entire functionality to access the Communote REST API.

If you want to use the Communote Client following constructor parameter are necessary:

TypeNameDescription
StringbaseURLURL of API of system you want to access 
(http://.../microblog/global/api/rest/v3_0)
Stringusernamelogin name of user who wants to access
Stringpasswordpassword of user

An overview of all Client methods you can find below.

Important Classes

Every resource has his own package. For example the topic resource is located in that package:\

com.communote.plugins.api.rest.client.resource.topic;

Subresources are located in subpackages and resources of subresources in subsubpackages an so on.

In every resource package you can found following classes.

Resource Classes

Resource classes represents the result of an request. So every resource class is an deserialized form of the returned GET request.

For an specific information about the attributes of an returned resource read the attribute documentation part of appropriate resource for GET and LIST (Resource Documentation).

Parameter Classes

Every parameter classes represent an HTTP-Request to create, get, edit, list or delete the appropriate resource.
For the naming of the parameter class the Client used following convention:

HTTP-MethodName of Parameter ClassExample for Topic
POSTCreate...ParameterCreateTopicParameter
PUTEdit...ParameterEditTopicParameter
GETGet...ParameterGetTopicParameter
LISTGet...ResourceParameterGetCollectionTopicParameter
DELETEDelete...ParameterDeleteTopicParameter

Take care that you choose the right parameter class. Some parameter classes have the same name so you must be careful that you have the right class. You can see this in the package path of the parameter class.

com.communote.plugins.api.rest.client.resource.topic.property;
com.communote.plugins.api.rest.client.resource.note.property;

The parameter classes contains all necessary parameters and attributes for the request with the appropriate HTTP-Method. Besides this, every parameter class contain tree important methods:

MethodReturnDescription
getUriPath()StringGet the path to resource
isValidParameterList()BooleanValid that all manatory parameters / attributes are set
getResourceJSONRepresentation()StringGet the serialize parameter class as json

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

For example you want to know witch parameters or attributes are necessary to create an topic with CreateTopicParameter or you need to know how to use them?

So check the reference of topic resource with an HTTP POST (convention table above) request.

Enumeration for Constants

All java files with an "E" at the beginning and after this any other upper case letter are enumerations. Enumerations are used for constant values of attributes and parameters.

Overview of Communote Client Resource Methods

Attachment

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createAttachmentCreateAttachmentParameterLong
getAttachmentGetAttachmentParameterAttachmentResource
getCollectionAttachmentGetCollectionAttachmentParameterList<AttachmentResource>
deleteAttachmentDeleteAttachmentParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.attachment

Package - Files

  • AttachmentResource.java
  • CreateAttachmentParameter.java
  • GetAttachmentParameter.java
  • GetCollectionAttachmentParameter.java
  • DeleteAttachmentParameter.java

Preview

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getAttachmentPreviewGetPreviewParameterPreviewResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.attachment.preview

Package - Files

  • PreviewResource.java
  • GetPreviewParameter.java

Group

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getGroupGetGroupParameterGroupResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.group

Package - Files

  • GroupResource.java
  • GetGroupParameter.java
  • EGroupIdentifier.java

Member

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getCollectionGroupMemberGetCollectionMemberParameterList<MemberResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.group.member

Package - Files

  • MemberResource.java
  • GetCollectionMemberParameter.java
  • EGroupIdentifier.java

LastModificationDate

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getCollectionLastModificationDateGetCollectionLastModificationDateParameterList<LastModificationDateResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.lastmodificationdate

Package - Files

  • LastModificationDateResource.java
  • GetCollectionLastModificationDateParameter.java
  • EType.java

Note

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createNoteCreateNoteParameterLong
editNoteEditNoteParameterLong
getNoteGetNoteParameterNoteResource
getCollectionNoteGetCollectionNoteParameterList<NoteResource>
deleteNoteDeleteNoteParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.note

Package - Files

  • NoteResource.java
  • CreateNoteParameter.java
  • EditNoteParameter.java
  • GetNoteParameter.java
  • GetCollectionNoteParameter.java
  • DeleteNoteParameter.java

Favorite

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createFavoriteCreateFavoriteParameterLong
getCollectionNoteFavoriteGetCollectionFavoriteParameterList<FavoriteResource>
deleteFavoriteDeleteFavoriteParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.note.favorite

Package - Files

  • FavoriteResource.java
  • CreateFavoriteParameter.java
  • GetCollectionFavoriteParameter.java
  • DeleteFavoriteParameter.java

Like

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createLikeCreateLikeParameterLong
getCollectionNoteLikeGetCollectionLikeParameterList<LikeResource>
deleteLikeDeleteLikeParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.note.like

Package - Files

  • LikeResource.java
  • CreateLikeParameter.java
  • GetCollectionLikeParameter.java
  • DeleteLikeParameter.java

Property

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createPropertyCreatePropertyParameterLong
getNotePropertyGetPropertyParameterPropertyResource
getCollectionNotePropertyGetCollectionPropertyParameterList<PropertyResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.note.property

Package - Files

  • PropertyResource.java
  • CreatePropertyParameter.java
  • GetPropertyParameter.java
  • GetCollectionPropertyParameter.java

Tag

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
editTagEditTagParameterLong
getTagGetTagParameterTagResource
getCollectionTagGetCollectionTagParameterList<TagResource>
deleteTagDeleteTagParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.tag

Package - Files

  • TagResource.java
  • EditTagParameter.java
  • GetTagParameter.java
  • GetCollectionTagParameter.java
  • DeleteTagParameter.java

TagStoreTagList

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getTagStoreTagListGetTagStoreTagListParameterTagStoreTagListResource
getCollectionTagStoreTagListGetCollectionTagStoreTagListParameterList<TagStoreTagListResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.tagstoretaglist

Package - Files

  • TagStoreTagListResource.java
  • GetTagStoreTagListParameter.java
  • GetCollectionTagStoreTagListParameter.java

TagStoreTag

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getTagStoreTagListTagStoreTagGetTagStoreTagParameterTagStoreTagResource
getCollectionTagStoreTagListTagStoreTagGetCollectionTagStoreTagParameterList<TagStoreTagResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.tagstoretaglist.tagstoretag

Package - Files

  • TagStoreTagResource.java
  • GetTagStoreTagParameter.java
  • GetCollectionTagStoreTagParameter.java

TagSuggestionList

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTagSuggestionListCreateTagSuggestionListParameterLong
getCollectionTagSuggestionListGetCollectionTagSuggestionListParameterList<TagSuggestionListResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.tagsuggestionlist

Package - Files

  • TagSuggestionListResource.java
  • CreateTagSuggestionListParameter.java
  • GetCollectionTagSuggestionListParameter.java
  • EF_topicAccess.java

TimelineNote

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTimelineNoteCreateTimelineNoteParameterLong
editTimelineNoteEditTimelineNoteParameterLong
getTimelineNoteGetTimelineNoteParameterTimelineNoteResource
getCollectionTimelineNoteGetCollectionTimelineNoteParameterList<TimelineNoteResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinenote

Package - Files

  • TimelineNoteResource.java
  • CreateTimelineNoteParameter.java
  • EditTimelineNoteParameter.java
  • GetTimelineNoteParameter.java
  • GetCollectionTimelineNoteParameter.java
  • EF_topicAccess.java
  • EUserNoteProperties.java
  • ERights.java

Property

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createPropertyCreatePropertyParameterLong
getTimelineNotePropertyGetPropertyParameterPropertyResource
getCollectionTimelineNotePropertyGetCollectionPropertyParameterList<PropertyResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinenote.property

Package - Files

  • PropertyResource.java
  • CreatePropertyParameter.java
  • GetPropertyParameter.java
  • GetCollectionPropertyParameter.java

TimelineNoteDiscussion

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getTimelineNoteTimelineNoteDiscussionGetTimelineNoteDiscussionParameterTimelineNoteDiscussionResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinenote.timelinenotediscussion

Package - Files

  • TimelineNoteDiscussionResource.java
  • GetTimelineNoteDiscussionParameter.java

TimelineNoteTag

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getTimelineNoteTimelineNoteTagGetTimelineNoteTagParameterTimelineNoteTagResource
getCollectionTimelineNoteTimelineNoteTagGetCollectionTimelineNoteTagParameterList<TimelineNoteTagResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinenote.timelinenotetag

Package - Files

  • TimelineNoteTagResource.java
  • GetTimelineNoteTagParameter.java
  • GetCollectionTimelineNoteTagParameter.java

TimelineTag

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTimelineTagCreateTimelineTagParameterLong
getCollectionTimelineTagGetCollectionTimelineTagParameterList<TimelineTagResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinetag

Package - Files

  • TimelineTagResource.java
  • CreateTimelineTagParameter.java
  • GetCollectionTimelineTagParameter.java
  • EF_topicAccess.java

TimelineTopic

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTimelineTopicCreateTimelineTopicParameterLong
getCollectionTimelineTopicGetCollectionTimelineTopicParameterList<TimelineTopicResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelinetopic

Package - Files

  • TimelineTopicResource.java
  • CreateTimelineTopicParameter.java
  • GetCollectionTimelineTopicParameter.java
  • EF_topicAccess.java

TimelineUser

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTimelineUserCreateTimelineUserParameterLong
getCollectionTimelineUserGetCollectionTimelineUserParameterList<TimelineUserResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.timelineuser

Package - Files

  • TimelineUserResource.java
  • CreateTimelineUserParameter.java
  • GetCollectionTimelineUserParameter.java
  • EF_topicAccess.java

Topic

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createTopicCreateTopicParameterLong
editTopicEditTopicParameterLong
getTopicGetTopicParameterTopicResource
getCollectionTopicGetCollectionTopicParameterList<TopicResource>
deleteTopicDeleteTopicParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic

Package - Files

  • TopicResource.java
  • CreateTopicParameter.java
  • EditTopicParameter.java
  • GetTopicParameter.java
  • GetCollectionTopicParameter.java
  • DeleteTopicParameter.java
  • ETopicIdentifier.java
  • ETopicListType.java

ChildTopic

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createChildTopicCreateChildTopicParameterLong
deleteChildTopicDeleteChildTopicParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.childtopic

Package - Files

  • ChildTopicResource.java
  • CreateChildTopicParameter.java
  • DeleteChildTopicParameter.java
  • EParentTopicIdentifier.java

ExternalObject

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createExternalObjectCreateExternalObjectParameterLong
editExternalObjectEditExternalObjectParameterLong
getTopicExternalObjectGetExternalObjectParameterExternalObjectResource
getCollectionTopicExternalObjectGetCollectionExternalObjectParameterList<ExternalObjectResource>
deleteExternalObjectDeleteExternalObjectParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.externalobject

Package - Files

  • ExternalObjectResource.java
  • CreateExternalObjectParameter.java
  • EditExternalObjectParameter.java
  • GetExternalObjectParameter.java
  • GetCollectionExternalObjectParameter.java
  • DeleteExternalObjectParameter.java
  • ETopicIdentifier.java

Follow

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createFollowCreateFollowParameterLong
getCollectionTopicFollowGetCollectionFollowParameterList<FollowResource>
deleteFollowDeleteFollowParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.follow

Package - Files

  • FollowResource.java
  • CreateFollowParameter.java
  • GetCollectionFollowParameter.java
  • DeleteFollowParameter.java

Property

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createPropertyCreatePropertyParameterLong
getTopicPropertyGetPropertyParameterPropertyResource
getCollectionTopicPropertyGetCollectionPropertyParameterList<PropertyResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.property

Package - Files

  • PropertyResource.java
  • CreatePropertyParameter.java
  • GetPropertyParameter.java
  • GetCollectionPropertyParameter.java

Right

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
editRightEditRightParameterLong
getTopicRightGetRightParameterRightResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.right

Package - Files

  • RightResource.java
  • EditRightParameter.java
  • GetRightParameter.java

Role

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createRoleCreateRoleParameterLong
editRoleEditRoleParameterLong
getTopicRoleGetRoleParameterRoleResource
getCollectionTopicRoleGetCollectionRoleParameterList<RoleResource>
deleteRoleDeleteRoleParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.role

Package - Files

  • RoleResource.java
  • CreateRoleParameter.java
  • EditRoleParameter.java
  • GetRoleParameter.java
  • GetCollectionRoleParameter.java
  • DeleteRoleParameter.java
  • ETopicIdentifier.java
  • ERole.java

RoleBulkExternal

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createRoleBulkExternalCreateRoleBulkExternalParameterLong
editRoleBulkExternalEditRoleBulkExternalParameterLong
getTopicRoleBulkExternalGetRoleBulkExternalParameterRoleBulkExternalResource
deleteRoleBulkExternalDeleteRoleBulkExternalParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.rolebulkexternal

Package - Files

  • RoleBulkExternalResource.java
  • CreateRoleBulkExternalParameter.java
  • EditRoleBulkExternalParameter.java
  • GetRoleBulkExternalParameter.java
  • DeleteRoleBulkExternalParameter.java
  • ETopicIdentifier.java

RoleBulkExternalTopicRight

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getTopicRoleBulkExternalRoleBulkExternalTopicRightGetRoleBulkExternalTopicRightParameterRoleBulkExternalTopicRightResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.rolebulkexternal.rolebulkexternaltopicright

Package - Files

  • RoleBulkExternalTopicRightResource.java
  • GetRoleBulkExternalTopicRightParameter.java
  • ERole.java

RoleExternal

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createRoleExternalCreateRoleExternalParameterLong
editRoleExternalEditRoleExternalParameterLong
getTopicRoleExternalGetRoleExternalParameterRoleExternalResource
getCollectionTopicRoleExternalGetCollectionRoleExternalParameterList<RoleExternalResource>
deleteRoleExternalDeleteRoleExternalParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.topic.roleexternal

Package - Files

  • RoleExternalResource.java
  • CreateRoleExternalParameter.java
  • EditRoleExternalParameter.java
  • GetRoleExternalParameter.java
  • GetCollectionRoleExternalParameter.java
  • DeleteRoleExternalParameter.java
  • ETopicIdentifier.java
  • ERole.java

User

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createUserCreateUserParameterLong
editUserEditUserParameterLong
getUserGetUserParameterUserResource
getCollectionUserGetCollectionUserParameterList<UserResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user

Package - Files

  • UserResource.java
  • CreateUserParameter.java
  • EditUserParameter.java
  • GetUserParameter.java
  • GetCollectionUserParameter.java

ExternalLogin

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getCollectionUserExternalLoginGetCollectionExternalLoginParameterList<ExternalLoginResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.externallogin

Package - Files

  • ExternalLoginResource.java
  • GetCollectionExternalLoginParameter.java

ExternalProperty

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getUserExternalLoginExternalPropertyGetExternalPropertyParameterExternalPropertyResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.externallogin.externalproperty

Package - Files

  • ExternalPropertyResource.java
  • GetExternalPropertyParameter.java

Follow

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createFollowCreateFollowParameterLong
getCollectionUserFollowGetCollectionFollowParameterList<FollowResource>
deleteFollowDeleteFollowParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.follow

Package - Files

  • FollowResource.java
  • CreateFollowParameter.java
  • GetCollectionFollowParameter.java
  • DeleteFollowParameter.java

Image

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getUserImageGetImageParameterImageResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.image

Package - Files

  • ImageResource.java
  • GetImageParameter.java
  • ESize.java

NavigationItem

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createNavigationItemCreateNavigationItemParameterLong
editNavigationItemEditNavigationItemParameterLong
getUserNavigationItemGetNavigationItemParameterNavigationItemResource
getCollectionUserNavigationItemGetCollectionNavigationItemParameterList<NavigationItemResource>
deleteNavigationItemDeleteNavigationItemParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.navigationitem

Package - Files

  • NavigationItemResource.java
  • CreateNavigationItemParameter.java
  • EditNavigationItemParameter.java
  • GetNavigationItemParameter.java
  • GetCollectionNavigationItemParameter.java
  • DeleteNavigationItemParameter.java

Observation

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
getUserObservationGetObservationParameterObservationResource
getCollectionUserObservationGetCollectionObservationParameterList<ObservationResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.observation

Package - Files

  • ObservationResource.java
  • GetObservationParameter.java
  • GetCollectionObservationParameter.java

Property

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createPropertyCreatePropertyParameterLong
getUserPropertyGetPropertyParameterPropertyResource
getCollectionUserPropertyGetCollectionPropertyParameterList<PropertyResource>

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.property

Package - Files

  • PropertyResource.java
  • CreatePropertyParameter.java
  • GetPropertyParameter.java
  • GetCollectionPropertyParameter.java

UserPreference

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
editUserPreferenceEditUserPreferenceParameterLong
getUserUserPreferenceGetUserPreferenceParameterUserPreferenceResource

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.userpreference

Package - Files

  • UserPreferenceResource.java
  • EditUserPreferenceParameter.java
  • GetUserPreferenceParameter.java

Preference

Methods

Please read the appropriate documentation part of Resources, for an specific information about the attributs an parameters in every parameter class.

NameParameterReturn
createPreferenceCreatePreferenceParameterLong
editPreferenceEditPreferenceParameterLong
getUserUserPreferencePreferenceGetPreferenceParameterPreferenceResource
deletePreferenceDeletePreferenceParametervoid

Package

Informations about packages and contained classes in packages are listed unter Important Classes.

com.communote.plugins.api.rest.client.resource.user.userpreference.preference

Package - Files

  • PreferenceResource.java
  • CreatePreferenceParameter.java
  • EditPreferenceParameter.java
  • GetPreferenceParameter.java
  • DeletePreferenceParameter.java