aclclient

Documentation

Index

• Constants
• type AclJoiningClient
  • func NewAclJoiningClient() AclJoiningClient
• type AclSpaceClient
  • func NewAclSpaceClient() AclSpaceClient
• type GetRecordsResponse
• type InvitePayload
• type InviteResponse

Constants

const CName = "common.acl.aclclient"

Types

type AclJoiningClient

type AclJoiningClient interface {
	app.Component
	AclGetRecords(ctx context.Context, spaceId, aclHead string) ([]*consensusproto.RawRecordWithId, error)
	RequestJoin(ctx context.Context, spaceId string, payload list.RequestJoinPayload) (aclHeadId string, err error)
	CancelJoin(ctx context.Context, spaceId string) (err error)
	InviteJoin(ctx context.Context, spaceId string, payload list.InviteJoinPayload) (aclHeadId string, err error)
	CancelRemoveSelf(ctx context.Context, spaceId string) (err error)
	RequestSelfRemove(ctx context.Context, spaceId string, aclList list.AclList) (err error)
}

func NewAclJoiningClient

func NewAclJoiningClient() AclJoiningClient

type AclSpaceClient

type AclSpaceClient interface {
	app.Component
	ReplaceInvite(ctx context.Context, invite InvitePayload) (list.InviteResult, error)
	ChangeInvitePermissions(ctx context.Context, inviteId string, permissions list.AclPermissions) error
	StopSharing(ctx context.Context, readKeyChange list.ReadKeyChangePayload) (err error)
	AddRecord(ctx context.Context, consRec *consensusproto.RawRecord) error
	RemoveAccounts(ctx context.Context, payload list.AccountRemovePayload) error
	AcceptRequest(ctx context.Context, payload list.RequestAcceptPayload) error
	DeclineRequest(ctx context.Context, identity crypto.PubKey) (err error)
	CancelRequest(ctx context.Context) (err error)
	ChangePermissions(ctx context.Context, permChange list.PermissionChangesPayload) (err error)
	RequestSelfRemove(ctx context.Context) (err error)
	RevokeInvite(ctx context.Context, inviteRecordId string) (err error)
	RevokeAllInvites(ctx context.Context) (err error)
	AddAccounts(ctx context.Context, add list.AccountsAddPayload) (err error)
}

func NewAclSpaceClient

func NewAclSpaceClient() AclSpaceClient

type GetRecordsResponse

type GetRecordsResponse struct {
	Records []*consensusproto.RawRecordWithId
}

type InvitePayload

type InvitePayload struct {
	InviteType  aclrecordproto.AclInviteType
	Permissions list.AclPermissions
}

type InviteResponse

type InviteResponse struct {
	InviteRec *consensusproto.RawRecord
	InviteKey crypto.PrivKey
}