Visibility tools
Read or change who can view your website. Private websites require TEISENDA sign-in.
On this page
Note
The connection covers the Space. You are a member, and the Space is not locked. A Space is a shared workspace in the app.
hosting_get_visibility can be called with any role, including Read-only. For hosting_set_visibility you need Owner, Administrator or User.
hosting_get_visibility Get visibility
reads only
Shows visibility and audience. For selected people or teams, the tool only gives the count, not names.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
hosting_set_visibility Set visibility
changes datadeletes, overwrites or changes what visitors seetwo steps
Makes a project public or private. A private website requires sign-in to TEISENDA; audience says who can view it afterwards.
Warning
Switching from private to public requires two calls: the first without confirm gives the confirmation sentence; the second with this sentence makes the website public.
The application should only send the sentence after you agree; see Three tools require a confirmation sentence. Making a project private or changing who can view a private project takes only one call.
audience has three levels. Each only applies to people who are currently members of the Space.
owner: only the account that created the project can view the website. This is unrelated to the Owner role in the Space, and no tool changes which account it is. If this account has left the Space, nobody can open the website until another level is set.selected: the people and teams selected in TEISENDA can view the website, always including the account that created the project. No tool selects them; do this in TEISENDA. See Set website visibility.space: every member of the Space can view the website.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
space | Integer | required | The ten-digit Space ID. |
project | Integer | required | The project number shown by hosting_list_projects. |
visibility | Text, one of public, private | required | public makes the project public, private makes it private. |
audience | Text, one of owner, selected, space | optional | Who can view a private website: owner, selected or space. If omitted with private, the project's existing value is retained; a new project has owner. With public, it has no effect: if the call includes a value anyway, TEISENDA saves it, and it applies again when the project becomes private. |
confirm | Text | optional | The application should omit it on the first call; the response then gives a confirmation sentence. It should only send this exact sentence after you agree. This is only needed when a call makes a project public that is not public already. |
If something goes wrong
Where a solution names a tool, ask the application to call it.
“Argument … is missing or does not have the expected form.”
In hosting_set_visibility, visibility is neither public nor private, or audience is not one of owner, selected or space; the message names the argument. Call the tool again with public or private and, for private, one of owner, selected or space.
Messages about the Space and project number are listed with the tools for Spaces and projects. All other messages that can occur with any tool are listed under Troubleshoot the Connector.