Skip navigation links

oracle.wcps.people
Class InvitationsExecutableResource

java.lang.Object
WebCenterRestExecutableResource
oracle.wcps.people.InvitationsExecutableResource

public class InvitationsExecutableResource

extends WebCenterRestExecutableResource

Constructor Summary

InvitationsExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Summary

void	acceptInvitation(java.lang.String loginId) Accept the invitation from the specified user.
void	createInvitation(java.lang.String loginId, java.lang.String message) Invite another user to join your connections list.
void	deleteInvitation(java.lang.String loginId) Delete the existing invitation to or from another user, from or to the authenticated user.
java.util.List<InvitationItem>	getMyInvitationsAsInvitee() Get all invitations where authenticated user is the invitee.
java.util.List<InvitationItem>	getMyInvitationsAsInvitor() Get all invitations where authenticated user is the invitor.
protected PersonExecutableResource	getPersonExecutableResource()
void	ignoreInvitation(java.lang.String loginId) Ignore the invitation from the specified user.
protected void	setPersonExecutableResource(PersonExecutableResource personExecutableResource)
protected void	setResourceType()

Methods inherited from class java.lang.Object

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

Constructor Detail

InvitationsExecutableResource

public InvitationsExecutableResource(WebCenterRestConnectionConfig restConfig)

Method Detail

setResourceType

protected void setResourceType()

getMyInvitationsAsInvitor

@PublicFunction(functionName="getMyInvitationsAsInvitor",
                descriptionBundleKey="provider.method.getMyInvitationsAsInvitor.description")
public java.util.List<InvitationItem> getMyInvitationsAsInvitor()

Get all invitations where authenticated user is the invitor.

Returns:

a list of invitations

getMyInvitationsAsInvitee

@PublicFunction(functionName="getMyInvitationsAsInvitee",
                descriptionBundleKey="provider.method.getMyInvitationsAsInvitee.description")
public java.util.List<InvitationItem> getMyInvitationsAsInvitee()

Get all invitations where authenticated user is the invitee.

Returns:

a list of invitations

createInvitation

@PublicFunction(functionName="createInvitation",
                descriptionBundleKey="provider.method.createInvitation.description")
public void createInvitation(@PublicParameter(parameterName="loginId",descriptionBundleKey="provider.parameter.createInvitation.loginId.description")
                                                                            java.lang.String loginId,
                                                                            @PublicParameter(parameterName="message",descriptionBundleKey="provider.parameter.createInvitation.message.description")
                                                                            java.lang.String message)

Invite another user to join your connections list.

Parameters:

loginId - The login id of the user that's being invited.

message - The message to send in the invitation.

deleteInvitation

@PublicFunction(functionName="deleteInvitation",
                descriptionBundleKey="provider.method.deleteInvitation.description")
public void deleteInvitation(@PublicParameter(parameterName="loginId",descriptionBundleKey="provider.parameter.deleteInvitation.loginId.description")
                                                                            java.lang.String loginId)

Delete the existing invitation to or from another user, from or to the authenticated user.

Parameters:

loginId - The login id of the user that's either the invitee or the invitor.

acceptInvitation

@PublicFunction(functionName="acceptInvitation",
                descriptionBundleKey="provider.method.acceptInvitation.description")
public void acceptInvitation(@PublicParameter(parameterName="loginId",descriptionBundleKey="provider.parameter.acceptInvitation.loginId.description")
                                                                            java.lang.String loginId)

Accept the invitation from the specified user.

Parameters:

loginId - The login id of the invitor or invitation, the invitee being the authenticated user.

ignoreInvitation

@PublicFunction(functionName="ignoreInvitation",
                descriptionBundleKey="provider.method.ignoreInvitation.description")
public void ignoreInvitation(@PublicParameter(parameterName="loginId",descriptionBundleKey="provider.parameter.ignoreInvitation.loginId.description")
                                                                            java.lang.String loginId)

Ignore the invitation from the specified user.

Parameters:

loginId - The login id of the invitor or invitation, the invitee being the authenticated user.

setPersonExecutableResource

protected void setPersonExecutableResource(PersonExecutableResource personExecutableResource)

getPersonExecutableResource

protected PersonExecutableResource getPersonExecutableResource()

Skip navigation links