TElBoxCollaborations.Add method

Discuss this help topic in SecureBlackbox Forum

TElBoxCollaborations.Add

TElBoxCollaborations See also

Filter: C# VB.NET Pascal C++ PHP Java

Adds a new collaboration.

Declaration

[C#]
    TElBoxCollaboration Add(TElBoxGroupInfo Group, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaboration Add(TElBoxUserInfo User, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaboration Add(string UserLogin, TSBBoxCollaborationRole Role, bool Notify);

[VB.NET]
    Function Add(ByVal Group As TElBoxGroupInfo, ByVal Role As TSBBoxCollaborationRole, ByVal Notify As Boolean) As TElBoxCollaboration
    Function Add(ByVal User As TElBoxUserInfo, ByVal Role As TSBBoxCollaborationRole, ByVal Notify As Boolean) As TElBoxCollaboration
    Function Add(ByVal UserLogin As String, ByVal Role As TSBBoxCollaborationRole, ByVal Notify As Boolean) As TElBoxCollaboration

[Pascal]
    function Add(Group: TElBoxGroupInfo; Role: TSBBoxCollaborationRole; Notify: Boolean): TElBoxCollaboration;
    function Add(User: TElBoxUserInfo; Role: TSBBoxCollaborationRole; Notify: Boolean): TElBoxCollaboration;
    function Add(const UserLogin: string; Role: TSBBoxCollaborationRole; Notify: Boolean): TElBoxCollaboration;

[C++]
    TElBoxCollaborationHandle Add(TElBoxGroupInfo &Group, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaborationHandle Add(TElBoxGroupInfo *Group, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaborationHandle Add(TElBoxUserInfo &User, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaborationHandle Add(TElBoxUserInfo *User, TSBBoxCollaborationRole Role, bool Notify);
    TElBoxCollaborationHandle Add(const std::string &UserLogin, TSBBoxCollaborationRole Role, bool Notify);

[PHP]
    TElBoxCollaboration Add(TElBoxGroupInfo $Group, integer $Role, bool $Notify)
    TElBoxCollaboration Add(TElBoxUserInfo $User, integer $Role, bool $Notify)
    TElBoxCollaboration Add(string $UserLogin, integer $Role, bool $Notify)

[Java]
    TElBoxCollaboration add(TElBoxUserInfo User, TSBBoxCollaborationRole Role, boolean Notify);
    TElBoxCollaboration add(String UserLogin, TSBBoxCollaborationRole Role, boolean Notify);
    TElBoxCollaboration add(TElBoxGroupInfo Group, TSBBoxCollaborationRole Role, boolean Notify);

Parameters

Group - the group which the new collaboration applies to.
Role - the role of the user or group.
Notify - specifies whether users hsould be notified about the new collaboration.
User - the user who the new collaboration applies to.
UserLogin - the login of the user who the new collaboration applies to.

TSBBoxCollaborationRole values:

[.NET] [C++]	[Pascal]	Description
bcrUnknown = 0	bcrUnknown	Unknown role
bcrEditor = 1	bcrEditor	Editor
bcrViewer = 2	bcrViewer	Viewer
bcrPreviewer = 3	bcrPreviewer	Previewer
bcrUploader = 4	bcrUploader	Uploader
bcrPreviewerUploader = 5	bcrPreviewerUploader	Previewer uploader
bcrViewerUploader = 6	bcrViewerUploader	Viewer uploader
bcrCoOwner = 7	bcrCoOwner	Co-owner

Return value

Returns a reference to the newly created collaboration object.

Description

Use this method to add a new collaboration to the list.

See also: IndexOf Item

Discuss this help topic in SecureBlackbox Forum