This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit conpherence.edit
conpherence.edit
conpherence.edit
API Method: conpherence.edit
API Method: conpherence.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Summary
- Apply transactions to create a new room or edit an existing one.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Transaction Summary
Transaction Summary
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| name | Room name. |
| topic | Room topic. |
| participants.add | Room participants. |
| participants.remove | Room participants. |
| participants.set | Room participants. |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| comment | Make comments. |
| mfa | Sign this transaction group with MFA. |
name
name
Room name.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New Room name. |
topic
topic
Room topic.
| Key | Type | Description |
|---|---|---|
| type | const | topic |
| value | string | New Room topic. |
participants.add
participants.add
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.add |
| value | list<user> | List of PHIDs to add. |
participants.remove
participants.remove
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.remove |
| value | list<user> | List of PHIDs to remove. |
participants.set
participants.set
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.set |
| value | list<user> | List of PHIDs to set. |
view
view
Change the view policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | view |
| value | string | New policy PHID or constant. |
edit
edit
Change the edit policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | edit |
| value | string | New policy PHID or constant. |
comment
comment
Make comments.
| Key | Type | Description |
|---|---|---|
| type | const | comment |
| value | string | Comment to add, formatted as remarkup. |
mfa
mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://gitpull.it/ --conduit-token <conduit-token> -- conpherence.edit
$ curl https://gitpull.it/api/conpherence.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://gitpull.it/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('conpherence.edit', $api_parameters);
print_r($result);
Public contents are in Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) or GNU Free Documentation License (at your option) unless otherwise noted. · Contact / Register