LysKOM Protocol A

Node:add-recipient, Next:sub-recipient, Previous:delete-text, Up:Protocol Requests

add-recipient [30] (1) Recommended

        add-recipient [30] (( text-no       : Text-No;
                              conf-no       : Conf-No;
                              recpt-type    : Info-Type ))
                -> ( );

Adds conf-no as recipient to text text-no. If recpt-type is 1, then a cc-recpt (see The Misc-Info List) is created; otherwise a recpt is created.

Since protocol version 8 this call can also be used to change a cc-recpt into a recpt and vice versa by simply adding a recipient that already exists.

Since protocol version 10 the recpt-type parameter is a Misc-Info. Only infos recpt, cc-recpt and bcc-recpt are accepted. In protocol version 9 and earlier this argument was a BOOL, that indicated if the recipient should be a cc-recpt (when true) or recpt (when false).

Example:

        1 26 1
        =1 2 22 12 17 6 97 4 197 1 5 4 256 1 0 *
        1 30 1 5 0
        =1
        1 26 1
        =1 2 22 12 17 6 97 4 197 1 5 4 256 1
           3 { 0 5 6 1 9 34 34 17 17 6 97 4 197 1 }
        1 30 1 5 1
        =1
        1 26 1
        =1 2 22 12 17 6 97 4 197 1 5 4 256 1
           3 { 1 5 6 1 9 34 34 17 17 6 97 4 197 1 }

This example show how conference 5 is added first as a recipient of text 1, then changed to a carbon-copy recipient. The misc-info list reflects these changes.

Error codes

login-first: Login required before issuing this call.
undefined-conference: The conference conf-no does not exist.
conference-zero: conf-no is zero.
no-such-text: The text text-no does not exist.
already-recipient: The conference conf-no is already a recipient of the same type as recpt-type.
illegal-info-type: recpt-type is not recpt, cc-recpt or bcc-recpt.
recipient-limit: The text already has the maximum number of recipients.
permission-denied: Attempt to change recipient types of a recipient, but not the author of the text or supervisor of the recipient.
access-denied: Attempt to add a conference as recipient that the person logged on does not have permission to add texts to. The client may have to chase the super conf chain.