Class ZmShare
<!ELEMENT share (grantee,grantor,link)> <!ATTLIST share xmlns CDATA #FIXED "urn:zimbraShare"> <!ATTLIST share version NMTOKEN #FIXED "0.1"> <!ATTLIST share action (new|edit|delete|accept|decline) #REQUIRED> <!ELEMENT grantee EMPTY> <!ATTLIST grantee id CDATA #REQUIRED> <!ATTLIST grantee name CDATA #REQUIRED> <!ATTLIST grantee email CDATA #REQUIRED> <!ELEMENT grantor EMPTY> <!ATTLIST grantor id CDATA #REQUIRED> <!ATTLIST grantor name CDATA #REQUIRED> <!ATTLIST grantor email CDATA #REQUIRED> <!ELEMENT link EMPTY> <!ATTLIST link id NMTOKEN #REQUIRED> <!ATTLIST link name CDATA #REQUIRED> <!ATTLIST link view (appointment|...) #REQUIRED> <!ATTLISt link perm CDATA #REQUIRED> Defined in: ZmShare.js.
Class Detail
ZmShare(params, granteePwd)
Creates a share with the given information about the sharer, the sharee, and
what is being shared.
Author: Andy Clark.
Field Detail
<static>
ZmShare.ACCEPT
Defines the "accept" action.
<static>
ZmShare.DECLINE
Defines the "decline" action.
<static>
ZmShare.DELETE
Defines the "delete" action.
<static>
ZmShare.EDIT
Defines the "edit" action.
<static>
ZmShare.NEW
Defines the "new" action.
<static>
ZmShare.NOTIFY
Defines the "notify" action.
<static>
ZmShare.PERM_ADMIN
Defines the "admin" allowed permission.
<static>
ZmShare.PERM_DELETE
Defines the "delete" allowed permission.
<static>
ZmShare.PERM_INSERT
Defines the "insert" allowed permission.
<static>
ZmShare.PERM_NOADMIN
Defines the "no admin" restricted permission.
<static>
ZmShare.PERM_NODELETE
Defines the "no delete" restricted permission.
<static>
ZmShare.PERM_NOINSERT
Defines the "no insert" restricted permission.
<static>
ZmShare.PERM_NOREAD
Defines the "no read" restricted permission.
<static>
ZmShare.PERM_NOWORKFLOW
Defines the "no workflow" restricted permission.
<static>
ZmShare.PERM_NOWRITE
Defines the "no write" restricted permission.
<static>
ZmShare.PERM_PRIVATE
Defines the "private" allowed permission.
<static>
ZmShare.PERM_READ
Defines the "read" allowed permission.
<static>
ZmShare.PERM_WORKFLOW
Defines the "workflow" allowed permission.
<static>
ZmShare.PERM_WRITE
Defines the "write" allowed permission.
<static>
ZmShare.RESEND
Defines the "resend" action.
<static>
ZmShare.REVOKE
Defines the "revoke" action.
<static>
ZmShare.ROLE_ADMIN
Defines the "admin" role.
<static>
ZmShare.ROLE_MANAGER
Defines the "manager" role.
<static>
ZmShare.ROLE_NONE
Defines the "none" role.
<static>
ZmShare.ROLE_VIEWER
Defines the "viewer" role.
<static>
ZmShare.TYPE_ALL
Defines the "all" type.
<static>
ZmShare.TYPE_COS
Defines the "COS" type.
<static>
ZmShare.TYPE_DOMAIN
Defines the "domain" type.
<static>
ZmShare.TYPE_GROUP
Defines the "group" type.
<static>
ZmShare.TYPE_GUEST
Defines the "guest" type.
<static>
ZmShare.TYPE_PUBLIC
Defines the "public" type.
<static>
ZmShare.TYPE_USER
Defines the "user" type.
Method Detail
accept(name, color, replyType, notes, callback, owner)
Accepts the share.
<static>
{ZmShare}
ZmShare.createFromDom(doc)
Creates the share from the DOM.
<static>
{ZmShare}
ZmShare.createFromJs(, grant)
Creates the share from JS.
<static>
{String}
ZmShare.getRoleActions(role)
Gets the role actions.
<static>
{String}
ZmShare.getRoleName(role)
Gets the role name.
<static>
ZmShare.getShareFromGrant(share, oldShare)
Updates a ZmShare that represents a grant
<static>
ZmShare.getShareFromLink(link, share)
Creates or updates a ZmShare from a ZmOrganizer that's a mountpoint. The grantee is
the current user.
<static>
ZmShare.getShareFromShareInfo(shareInfo, share)
Creates or updates a ZmShare from share info that comes in JSON form from
GetShareInfoResponse.
grant(perm, pw, replyType, shareAction, batchCmd, batchCmd)
Grants the permission.
{Boolean}
hasPrivateAccess()
Checks if the private permission exists on this share.
{Boolean}
isAdmin()
Checks if the admin permission exists on this share.
{Boolean}
isAll()
Checks if the grantee type is "all".
{Boolean}
isDelete()
Checks if the delete permission exists on this share.
{Boolean}
isDomain()
Checks if the grantee type is "domain".
{Boolean}
isGroup()
Checks if the grantee type is "group".
{Boolean}
isGuest()
Checks if the grantee type is "guest".
{Boolean}
isInsert()
Checks if the insert permission exists on this share.
{Boolean}
isPermAllowed(perm)
Checks if the given permission exists on this share.
{Boolean}
isPermRestricted(perm)
Checks if the given permission is restricted for this share.
{Boolean}
isPublic()
Checks if the grantee type is "public".
{Boolean}
isRead()
Checks if the read permission exists on this share.
{Boolean}
isUser()
Checks if the grantee type is "user".
{Boolean}
isWorkflow()
Checks if the workflow permission exists on this share.
{Boolean}
isWrite()
Checks if the write permission exists on this share.
revoke(callback)
Revokes the share.
revokeMultiple(callback, args, batchCmd)
Revokes multiple shares.
<static>
ZmShare.revokeOrphanGrants(zid, granteeType, callback, batchCmd)
Revokes all grants for the given zid (one whose account has been
removed).
sendMessage(mode, addrs, owner, batchCmd)
Sends a message.
setPermissions(perm)
Sets the permission.
{String}
toString()
Returns a string representation of the object.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:39 GMT-0400 (EDT)
|