Methods
Description
BP_REST_Document_Details_Endpoint::register_routes()

Register the component routes.

Source: bp-document/classes/class-bp-rest-document-details-endpoint.php:33

BP_REST_Document_Endpoint::__construct()

Constructor.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:23

BP_REST_Document_Endpoint::assemble_response_data()

Get documents.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1144

BP_REST_Document_Endpoint::bbp_document_get_rest_field_callback()

The function to use to get documents of the topic/reply REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2359

BP_REST_Document_Endpoint::bbp_document_update_rest_field_callback()

The function to use to update the document’s value of the topic REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2398

BP_REST_Document_Endpoint::bp_documents_get_rest_field_callback()

The function to use to get documents of the activity REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2100

BP_REST_Document_Endpoint::bp_documents_get_rest_field_callback_messages()

The function to use to get documents of the messages REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2267

BP_REST_Document_Endpoint::bp_documents_update_rest_field_callback()

The function to use to update the document’s value of the activity REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2140

BP_REST_Document_Endpoint::bp_documents_update_rest_field_callback_messages()

The function to use to update the documents value of the messages REST Field.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2306

BP_REST_Document_Endpoint::bp_rest_activity_query_arguments()

Filter Query argument for the activity for document support.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2539

BP_REST_Document_Endpoint::bp_rest_check_privacy_restriction()

Check user access based on the privacy for the single document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1962

BP_REST_Document_Endpoint::bp_rest_create_document()

Create the Document IDs from Upload IDs.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1782

BP_REST_Document_Endpoint::bp_rest_document_default_scope()

Get default scope for the document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1918

BP_REST_Document_Endpoint::bp_rest_document_support()

Added document support for activity, forum and messages.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1992

BP_REST_Document_Endpoint::bp_rest_forums_collection_params()

Extend the parameters for the Topics and Reply Endpoints.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2559

BP_REST_Document_Endpoint::bp_rest_message_query_arguments()

Filter Query argument for the Messages for document support.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:2579

BP_REST_Document_Endpoint::create_item()

Create documents.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:512

BP_REST_Document_Endpoint::create_item_permissions_check()

Check if a given request has access to create a document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:600

BP_REST_Document_Endpoint::delete_item()

Delete a single document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:942

BP_REST_Document_Endpoint::delete_item_permissions_check()

Checks if a given request has access to for the user.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1007

BP_REST_Document_Endpoint::document_get_prepare_response()

Prepare object response for the document/folder.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1243

BP_REST_Document_Endpoint::get_collection_params()

Get the query params for collections.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1572

BP_REST_Document_Endpoint::get_document_current_user_permissions()

Get document permissions based on current user.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1691

BP_REST_Document_Endpoint::get_endpoint_args_for_item_schema()

Select the item schema arguments needed for the CREATABLE methods.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1061

BP_REST_Document_Endpoint::get_item()

Retrieve a single document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:395

BP_REST_Document_Endpoint::get_item_permissions_check()

Checks if a given request has access to get all users.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:441

BP_REST_Document_Endpoint::get_item_schema()

Get the document schema, conforming to JSON Schema.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1358

BP_REST_Document_Endpoint::get_items()

Retrieve documents.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:235

BP_REST_Document_Endpoint::get_items_permissions_check()

Checks if a given request has access to get all users.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:332

BP_REST_Document_Endpoint::prepare_item_for_response()

Prepares document data for return as an object.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1166

BP_REST_Document_Endpoint::prepare_links()

Prepare links for the request.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:1196

BP_REST_Document_Endpoint::register_routes()

Register the component routes.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:35

BP_REST_Document_Endpoint::update_item()

Update a document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:741

BP_REST_Document_Endpoint::update_item_permissions_check()

Check if a given request has access to update a document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:865

BP_REST_Document_Endpoint::upload_item()

Upload Document.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:116

BP_REST_Document_Endpoint::upload_item_permissions_check()

Checks if a given request has access to get all users.

Source: bp-document/classes/class-bp-rest-document-endpoint.php:180

BP_REST_Document_Folder_Endpoint::__construct()

Constructor.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:30

BP_REST_Document_Folder_Endpoint::assemble_response_data()

Get document folders.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:994

BP_REST_Document_Folder_Endpoint::bp_rest_check_folder_privacy_restriction()

Check user access based on the privacy for the single folder.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:1203

BP_REST_Document_Folder_Endpoint::create_item()

Create document folder.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:380

BP_REST_Document_Folder_Endpoint::create_item_permissions_check()

Check if a given request has access to create a folder.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:450

BP_REST_Document_Folder_Endpoint::delete_item()

Delete a single Folder.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:765

BP_REST_Document_Folder_Endpoint::delete_item_permissions_check()

Checks if a given request has access to for the user.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:830

BP_REST_Document_Folder_Endpoint::folder_tree_items()

Retrieve document folder tree.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:892

BP_REST_Document_Folder_Endpoint::folder_tree_items_permissions_check()

Checks if a given request has access to view the folder tree.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:962

BP_REST_Document_Folder_Endpoint::get_collection_params()

Get the query params for collections.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:1103

BP_REST_Document_Folder_Endpoint::get_endpoint_args_for_item_schema()

Select the item schema arguments needed for the CREATABLE methods.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:1014

BP_REST_Document_Folder_Endpoint::get_item()

Retrieve a single Folder.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:265

BP_REST_Document_Folder_Endpoint::get_item_permissions_check()

Checks if a given request has access to get all users.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:311

BP_REST_Document_Folder_Endpoint::get_item_schema()

Get the document folder schema, conforming to JSON Schema.

Source: bp-document/classes/class-bp-rest-document-folder-endpoint.php:1079