cral.api.core.sites — org.saidone/cral 0.3.0

create-person-site-membership-requests clj

(create-person-site-membership-requests ticket person-id body)

(create-person-site-membership-requests ticket
                                        person-id
                                        body
                                        query-params
                                        &
                                        [opts])

Create a site membership request for yourself on the site with the identifier of id, specified in the body. The result of the request differs depending on the type of site.

• For a public site, you join the site immediately as a SiteConsumer.
• For a moderated site, your request is added to the site membership request list. The request waits for approval from the Site Manager.
• You cannot request membership of a private site. Members are invited by the site administrator.

You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

create-site clj

(create-site ticket body)

(create-site ticket body query-params & [opts])

Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title. The site id must be unique and only contain alphanumeric and/or dash characters.
Note: the id of a site cannot be updated once the site has been created.
More info here.

delete-person-site-membership clj

(delete-person-site-membership ticket person-id site-id & [opts])

Deletes person person-id as a member of site site-id. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

delete-person-site-membership-request clj

(delete-person-site-membership-request ticket person-id site-id & [opts])

Deletes the site membership request to site site-id for person person-id. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

delete-site clj

(delete-site ticket site-id)

(delete-site ticket site-id query-params & [opts])

Deletes the site with site-id.
More info here.

get-person-site-membership clj

(get-person-site-membership ticket person-id site-id & [opts])

Gets site membership information for person person-id on site site-id. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

get-person-site-membership-request clj

(get-person-site-membership-request ticket person-id site-id)

(get-person-site-membership-request ticket
                                    person-id
                                    site-id
                                    query-params
                                    &
                                    [opts])

Gets the site membership request for site site-id for person person-id, if one exists. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

get-site clj

(get-site ticket site-id)

(get-site ticket site-id query-params & [opts])

Gets information for site site-id. You can use the relations parameter in query-params to include one or more relate entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The sites entity has two children, containers and members. The following relations parameter returns all the container and member objects related to the site site-id: containers,members
More info here.

list-person-site-membership-requests clj

(list-person-site-membership-requests ticket person-id)

(list-person-site-membership-requests ticket person-id query-params & [opts])

Gets a list of the current site membership requests for person person-id. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

list-person-site-memberships clj

(list-person-site-memberships ticket person-id)

(list-person-site-memberships ticket person-id query-params & [opts])

Gets a list of site membership information for person person-id. You can use the -me- string in place of person-id to specify the currently authenticated user. You can use the where parameter in query-params to filter the returned sites by visibility or site preset.
Example to filter by visibility, use any one of:

(visibility='PRIVATE')
(visibility='PUBLIC')
(visibility='MODERATED')

Example to filter by site preset:

(preset='site-dashboard')

The default sort order for the returned list is for sites to be sorted by ascending title.
You can override the default by using the order-by parameter in query-params. You can specify one or more of the following fields in the order-by parameter:

• id
• title
• role

More info here.

list-sites clj

(list-sites ticket)

(list-sites ticket query-params & [opts])

Gets a list of sites in this repository. You can use the where parameter in query-params to filter the returned sites by visibility or site preset.
More info here.

update-person-site-membership-request clj

(update-person-site-membership-request ticket person-id site-id body)

(update-person-site-membership-request ticket
                                       person-id
                                       site-id
                                       body
                                       query-params
                                       &
                                       [opts])

Updates the message for the site membership request to site site-id for person person-id. You can use the -me- string in place of person-id to specify the currently authenticated user.
More info here.

update-site clj

(update-site ticket site-id body)

(update-site ticket site-id body query-params & [opts])

Update the details for the given site site-id. Site Manager or otherwise a (site) admin can update title, description or visibility.
Note: the id of a site cannot be updated once the site has been created.
More info here.