Skip to content

Latest commit

 

History

History
157 lines (72 loc) · 2.74 KB

Freshdesk-Resources-Forum.md

File metadata and controls

157 lines (72 loc) · 2.74 KB
Raw

Freshdesk\Resources\Forum

Forum resource

Provides access to the forum resources

Methods

create

array|null Freshdesk\Resources\Forum::create(integer $id, array $data)

Create a forum for a category.

  • Visibility: public

Arguments

  • $id integer - <p>The category Id</p>
  • $data array

all

mixed Freshdesk\Resources\Forum::all(array|null $query)

Get a list of all agents.

Use filters ($query) to view only specific resources (those which match the criteria that you choose).

  • Visibility: public

Arguments

  • $query array|null

view

array|null Freshdesk\Resources\Forum::view(integer $id, array|null $query)

View a resource

Use 'include' to embed additional details in the response. Each include will consume an additional credit. For example if you embed the requester and company information you will be charged a total of 3 API credits for the call. See Freshdesk's documentation for details.

  • Visibility: public

Arguments

  • $id integer - <p>The resource id</p>
  • $query array|null

update

array|null Freshdesk\Resources\Forum::update(integer $id, array $data)

Update a resource

Updates the resources for the given $id with the supplied data/.

  • Visibility: public

Arguments

  • $id integer - <p>The resource id</p>
  • $data array - <p>The data</p>

delete

array|null Freshdesk\Resources\Forum::delete(\Freshdesk\Resources\Traits\in $id)

Delete a resource

Delete a resource by $id

  • Visibility: public

Arguments

  • $id Freshdesk\Resources\Traits\in - <p>The resource id</p>

monitor

array|null Freshdesk\Resources\Forum::monitor($id, $userId)

Monitor a resource

Monitor a resource for the given user

  • Visibility: public

Arguments

  • $id mixed - <p>The id of the resource</p>
  • $userId mixed - <p>The id of the user</p>

unmonitor

array|null Freshdesk\Resources\Forum::unmonitor($id, $userId)

Unmonitor a resource

Unmonitor a resource for the given user

  • Visibility: public

Arguments

  • $id mixed - <p>The id of the resource</p>
  • $userId mixed - <p>The id of the user</p>

monitorStatus

array|null Freshdesk\Resources\Forum::monitorStatus($id, $userId)

Monitor status

Get the monitoring status of the topic for the user

  • Visibility: public

Arguments

  • $id mixed - <p>The id of the resource</p>
  • $userId mixed - <p>The id of the user</p>