The highest tagged major version is
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidParameters = errors.New("invalid parameters")
ErrInvalidParameters is the error returned by the shares endpoint when the request does not contain required properties.
var ErrServiceNotTrusted = errors.New("service is not trusted to accept invitations")
ErrServiceNotTrusted is the error returned by the invite-accepted endpoint when the service is not trusted to accept invitations.
var ErrTokenInvalid = errors.New("the invitation token is invalid")
ErrTokenInvalid is the error returned by the invite-accepted endpoint when the token is not valid.
var ErrTokenNotFound = errors.New("token not found")
ErrTokenNotFound is the error returned by the invite-accepted endpoint when the request is done using a not existing token.
var ErrUserAlreadyAccepted = errors.New("user already accepted an invitation token")
ErrUserAlreadyAccepted is the error returned by the invite-accepted endpoint when a user is already know by the remote cloud.
Functions ¶
This section is empty.
Types ¶
type InviteAcceptedRequest ¶
type InviteAcceptedRequest struct {
UserID string `json:"userID"`
Email string `json:"email"`
Name string `json:"name"`
RecipientProvider string `json:"recipientProvider"`
Token string `json:"token"`
}
InviteAcceptedRequest contains the parameters for accepting an invitation.
type NewShareRequest ¶
type NewShareRequest struct {
}
NewShareRequest contains the parameters for creating a new OCM share.
type NewShareResponse ¶
type NewShareResponse struct {
}
NewShareResponse is the response returned when creating a new share.
type OCMClient ¶
type OCMClient struct {
// contains filtered or unexported fields
}
OCMClient is the client for an OCM provider.
func (*OCMClient) InviteAccepted ¶
func (c *OCMClient) InviteAccepted(ctx context.Context, endpoint string, r *InviteAcceptedRequest) (*User, error)
InviteAccepted informs the sender that the invitation was accepted to start sharing https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org#/paths/~1invite-accepted/post
func (*OCMClient) NewShare ¶
func (c *OCMClient) NewShare(ctx context.Context, endpoint string, r *NewShareRequest) (*NewShareResponse, error)
NewShare creates a new share. https://github.com/cs3org/OCM-API/blob/223285aa4d828ed85c361c7382efd08c42b5e719/spec.yaml
Source Files