API Documentation
Back to top  

Disciple_Tools_Contacts_Endpoints

Class Disciple_Tools_Contacts_Endpoints

package

Disciple_Tools\Posts\Contacts

Methods

Disciple_Tools_Contacts_Endpoints constructor.

__construct()

accept_contact

accept_contact(\WP_REST_Request $request) : array|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|\WP_Error|\WP_REST_Response

Add the api routes

add_api_routes()

add_related_info_to_contacts

add_related_info_to_contacts(array $contacts) : array

Arguments

$contacts

array

Response

array

add_shared

add_shared(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

contact_transfer

contact_transfer(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

Create a contact

create_contact(\WP_REST_Request $request) : string|array
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

Response

string|array

The contact on success

delete_comment

delete_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

get_activity

get_activity(\WP_REST_Request $request) : array|null|object|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|null|object|\WP_Error|\WP_REST_Response

get_comments

get_comments(\WP_REST_Request $request) : array|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|integer|\WP_Error|\WP_REST_Response

Get a single contact by ID

get_contact(\WP_REST_Request $request) : array|\WP_Error
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

Response

array|\WP_Error

The contact on success

get_contact_counts

get_contact_counts(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

get_contacts_compact

get_contacts_compact(\WP_REST_Request $request) : array|\WP_Query

Arguments

$request

\WP_REST_Request

Response

array|\WP_Query

get_duplicates_on_contact

get_duplicates_on_contact(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

get_following

get_following(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

get_multi_select_options

get_multi_select_options(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

get_settings

get_settings()

get_single_activity

get_single_activity(\WP_REST_Request $request) : array|null|object|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|null|object|\WP_Error|\WP_REST_Response

Get Contacts viewable by a user

get_viewable_contacts(\WP_REST_Request $request) : array|\WP_Error
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

Response

array|\WP_Error

return the user's contacts

Public_Hooks. Ensures only one instance of Public_Hooks is loaded or can be loaded.

instance() : \Disciple_Tools_Contacts_Endpoints
static

Response

\Disciple_Tools_Contacts_Endpoints

instance

post_comment

post_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

Public key processing utility. Use this at the beginning of public endpoints

process_token(\WP_REST_Request $request) : array|\WP_Error

Arguments

$request

\WP_REST_Request

Response

array|\WP_Error

public_contact_transfer

public_contact_transfer(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

Create a contact from the PUBLIC api.

public_create_contact(\WP_REST_Request $request) : array|\WP_Error
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

as application/json

Response

array|\WP_Error

The new contact Id on success, an error on failure

public_post_comment

public_post_comment(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

remove_shared

remove_shared(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

revert_activity

revert_activity(\WP_REST_Request $request) : array|null|object|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|null|object|\WP_Error|\WP_REST_Response

search_viewable_contacts

search_viewable_contacts(\WP_REST_Request $request)

Arguments

$request

\WP_REST_Request

setup_contacts_specific_endpoints

setup_contacts_specific_endpoints(\string $namespace)

Arguments

$namespace

\string

shared_with

shared_with(\WP_REST_Request $request) : array|mixed|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

array|mixed|\WP_Error|\WP_REST_Response

update_comment

update_comment(\WP_REST_Request $request) : false|integer|\WP_Error|\WP_REST_Response

Arguments

$request

\WP_REST_Request

Response

false|integer|\WP_Error|\WP_REST_Response

Update a single contact by ID

update_contact(\WP_REST_Request $request) : \WP_REST_Response|\WP_Error
access

public
since 0.1.0

Arguments

$request

\WP_REST_Request

Response

\WP_REST_Response|\WP_Error

Contact_id on success

yes_no_to_boolean

yes_no_to_boolean(string $yes_no) : boolean
static
Throws
\WP_Error|boolean

'Expected yes or no'.

Arguments

$yes_no

string

Response

boolean

Properties

Public_Hooks instance variable

_instance : object
static
var

Public_Hooks instance variable

Type(s)

object

The Public_Hooks rest api variables

version :

Type(s)

context

context :

Type(s)

namespace

namespace :

Type(s)

public_namespace

public_namespace :

Type(s)

namespace_v2

namespace_v2 :

Type(s)