module Tilia::DavAcl::IPrincipal

IPrincipal interface

Implement this interface to define your own principals

Public Instance Methods

alternate_uri_set() click to toggle source

Returns a list of alternative urls for a principal

This can for example be an email address, or ldap url.

@return array

# File lib/tilia/dav_acl/i_principal.rb, line 14
def alternate_uri_set
end
display_name() click to toggle source

Returns the displayname

This should be a human readable name for the principal. If none is available, return the nodename.

@return string

# File lib/tilia/dav_acl/i_principal.rb, line 59
def display_name
end
group_member_set() click to toggle source

Returns the list of group members

If this principal is a group, this function should return all member principal uri's for the group.

@return array

# File lib/tilia/dav_acl/i_principal.rb, line 29
def group_member_set
end
group_member_set=(principals) click to toggle source

Sets a list of group members

If this principal is a group, this method sets all the group members. The list of members is always overwritten, never appended to.

This method should throw an exception if the members could not be set.

@param array principals @return void

# File lib/tilia/dav_acl/i_principal.rb, line 50
def group_member_set=(principals)
end
group_membership() click to toggle source

Returns the list of groups this principal is member of

If this principal is a member of a (list of) groups, this function should return a list of principal uri's for it's members.

@return array

# File lib/tilia/dav_acl/i_principal.rb, line 38
def group_membership
end
principal_url() click to toggle source

Returns the full principal url

@return string

# File lib/tilia/dav_acl/i_principal.rb, line 20
def principal_url
end