vBulletin v6.0.4

vB_Api_Content_Privatemessage extends vB_Api_Content_Text
in package

vBApi

vB_Api_Content_Privatemessage

Constants

PARTICIPANTS_CHANNEL = 'Channel'
PARTICIPANTS_PM = 'PrivateMessage'
PARTICIPANTS_POLL = 'Poll'

Methods

__serialize() : array<string|int, mixed>
__sleep() : array<string|int, mixed>
__unserialize() : void
__wakeup() : void
acceptRequest() : bool: Accepts a user follow request or a channel ownership/moderation/membership request
add() : int: Adds a new private message
addPMRecipients() : mixed
addPMRecipientsByUsernames() : mixed
autoPopulatePreviewImage() : mixed: DEPRECATED - This is now handled internally by the library, nothing is called from controllers.
buildPmTotals() : mixed: Calculates the number of private messages that a user has in the system Used to limit pm abilities based on overage of this count
callNamed() : The: Call the given api function by name with a named arguments list.
canUsePmSystem() : bool: Private messaging can be disabled either by pmquota or enablepms
checkApiState() : mixed: This method checks whether the API method is enabled.
checkFolders() : mixed: Checks that we have all the folders for the current user, and the set folders are there.
cleanInput() : mixed: Cleans the input in the $data array, directly updating $data.
cleanPreviewContent() : mixed: Takes a node record and removes the data cannot be viewed based on public_preview.
clearCache() : mixed: Clears all previously loaded API objects.
createMessageFolder() : int: Creates a new message folder. It returns false if the record already exists and the id if it is able to create the folder
createQuoteText() : string: This returns the text to quote a node. Used initially for private messaging.
delete() : bool: Permanently deletes a node
deleteFolder() : mixed: Deletes a folder and moves its contents to trash
deleteMessage() : bool: Permanently deletes a message
deleteMessages() : array<string|int, mixed>: Delete private messages. Once deleted user won't be able to retrieve them again.
deleteMessagesForUser() : array<string|int, mixed>: Deletes all pms for a given user
deleteSentMessagesForUser() : array<string|int, mixed>: Deletes all pms for a given user
denyRequest() : array<string|int, mixed>: Denies a user follow request
extractMedia() : mixed: Extracts the video and photo content from text.
fetchFolders() : mixed: Returns the cached folder information
fetchParticipants() : array<string|int, mixed>: Returns an array of all users participating in a discussion
fetchSummary() : array<string|int, mixed>: Returns a summary of messages for current user
fetchTableName() : array<string|int, mixed>: Returns the tables used by this content type.
getApiClassName() : mixed
getAutoparseLinks() : mixed: Returns the autoparselinks setting. In the public API for createcontent getPreview() use, not really meant for regular usage.
getBareContent() : mixed: Returns the node content, channel routeid and title, and starter route and title, but no permissions or other subsidiary data
getBbcodeOptions() : array<string|int, mixed>: Returns an array with bbcode options for PMs
getContent() : mixed: Alias for @getFullContent
getContentApi() : mixed: Returns a content api of the appropriate type
getConversationParent() : array<string|int, mixed>|false: Gets the conversation starter for a node. If the node is a channel it returns the channel array.
getDataForParse() : array<string|int, mixed>: Gets the data the presentation layer needs to have to parse the rawtext.
getDeletedItemsFolderId() : int: Gets the deleted_items folder id
getFolderInfoFromId() : array<string|int, mixed>: Gets the folder information from a given folderid. The folderid requested should belong to the user who is requesting.
getFolderMsgCount() : array<string|int, mixed>: Gets the count of undeleted messages in a folder
getForward() : array<string|int, mixed>: Gets the title and forward
getFullContent() : array<string|int, mixed>: Returns the node content as an associative array
getHeaderCounts() : array<string|int, mixed>: Gets the count of unread messages, requests, & notifications for regular users, and also pending posts & reports for admins and moderators with access.
getInfractionFolderId() : int: Gets the infractions folder id
getMessage() : array<string|int, mixed>: Gets a message
getOpenReportsCount() : int: Gets the count of open reports
getPendingPostFolderId() : int: Gets the pending posts folder id
getQuotes() : string: Returns a string with quoted strings in bbcode format.
getQuoteText() : string: This returns the text to quote a node. Used initially for private messaging.
getReplyText() : mixed: Returns the text for a "reply" or "forward" message. Not implemented yet
getRequest() : array<string|int, mixed>: Get a single request
getSearchJSON() : string: Returns a formatted json string appropriate for the search api interface
getTextCountChange() : int: Returns textCountChange property
getTimeNow() : int: Gives the current board time- needed to set publishdate.
getUnreadInboxCount() : int: Gets the count of undeleted messages & notifications
instance() : vB_Api: Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
instanceInternal() : vB_Api: Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
isPublished() : bool: Determines if this record is in a published state
isVisitorMessage() : bool: Determines whether a specific node is a visitor message
listFolders() : array<string|int, mixed>: Lists the folders.
listMessages() : array<string|int, mixed>: Lists messages for current user
listNotifications() : array<string|int, mixed>: Lists notifications for current user
listRequests() : mixed: Lists messages for current user
map_vb4_input_to_vb5() : string: Returns vb5 api method name.
map_vb5_errors_to_vb4() : mixed: Alters the error array in any way necessary to interface correctly with vb4.
map_vb5_output_to_vb4() : mixed: Alters the output array in any way necessary to interface correctly with vb4.
moveMessage() : bool: Moves a message to a different folder
previewMessages() : mixed: Gets the preview for the messages
resetFolders() : mixed: Clears the cached folder information
setRead() : standard: Sets a message to read
toTrashcan() : mixed: Moves a node to the trashcan. Wrapper for deleteMessage()
undeleteMessage() : bool: Moves a message back to user inbox folder
update() : bool: Updates a record
updateFolderTitle() : array<string|int, mixed>: Updates the title

PARTICIPANTS_CHANNEL


    public
        mixed
    PARTICIPANTS_CHANNEL
    = 'Channel'

PARTICIPANTS_PM


    public
        mixed
    PARTICIPANTS_PM
    = 'PrivateMessage'

PARTICIPANTS_POLL


    public
        mixed
    PARTICIPANTS_POLL
    = 'Poll'

__serialize()


    public
                    __serialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

__sleep()


    public
                    __sleep() : array<string|int, mixed>

Return values

array<string|int, mixed>

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__wakeup()


    public
                    __wakeup() : void

acceptRequest()

Accepts a user follow request or a channel ownership/moderation/membership request


    public
                    acceptRequest(mixed $nodeid) : bool

Parameters

$nodeid : mixed

Return values

bool

add()

Adds a new private message


    public
                    add(mixed $data[, mixed $options = array() ]) : int

Parameters

$data : mixed

-- Array of field => value pairs which define the record.

$options : mixed = array()

-- Understands skipTransaction, skipFloodCheck, floodchecktime, skipDupCheck, skipNotification, nl2br, autoparselinks.

nl2br: if TRUE, all \n will be converted to
so that it's not removed by the html parser (e.g. comments).
wysiwyg: if true convert html to bbcode. Defaults to true if not given.

Return values

int —

the new nodeid.

addPMRecipients()


    public
                    addPMRecipients(mixed $pmid, mixed $recipients) : mixed

Parameters

$pmid : mixed
$recipients : mixed

addPMRecipientsByUsernames()


    public
                    addPMRecipientsByUsernames(mixed $pmid[, mixed $usernames = array() ][, mixed $usernamesToIds = array() ][, mixed $delimiter = ';' ]) : mixed

Parameters

$pmid : mixed
$usernames : mixed = array()
$usernamesToIds : mixed = array()
$delimiter : mixed = ';'

autoPopulatePreviewImage()

DEPRECATED - This is now handled internally by the library, nothing is called from controllers.


    public
                    autoPopulatePreviewImage(mixed $nodeId) : mixed

NOTE: This is still used by some upgrade steps, so we can't remove it completely at this time.

Populates the previewimage field for this node. To be called after the node is saved and the attachments added.

Finds the first image in the post text that can be used as a previewimage (uploaded here), or uses the first image attachment.

Parameters

$nodeId : mixed

buildPmTotals()

Calculates the number of private messages that a user has in the system Used to limit pm abilities based on overage of this count


    public
                    buildPmTotals(mixed $userids) : mixed

Parameters

$userids : mixed

callNamed()

Call the given api function by name with a named arguments list.


    public
                    callNamed() : The

Used primarily to translate REST requests into API calls.

Return values

The —

return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.

canUsePmSystem()

Private messaging can be disabled either by pmquota or enablepms


    public
                    canUsePmSystem([mixed $userid = null ]) : bool

Parameters

$userid : mixed = null

Return values

bool —

True if the current user can use the PM system, false otherwise

checkApiState()

This method checks whether the API method is enabled.


    public
                    checkApiState(mixed $method) : mixed

For extensions check make sure $controller property is already set.

Parameters

$method : mixed

checkFolders()

Checks that we have all the folders for the current user, and the set folders are there.


    public
                    checkFolders([mixed $userid = false ]) : mixed

Parameters

$userid : mixed = false

cleanInput()

Cleans the input in the $data array, directly updating $data.


    public
                    cleanInput(mixed $data[, mixed $nodeid = false ]) : mixed

Parameters

$data : mixed
$nodeid : mixed = false

cleanPreviewContent()

Takes a node record and removes the data cannot be viewed based on public_preview.


    public
                    cleanPreviewContent(mixed $record) : mixed

It's called from the search Api.

Parameters

$record : mixed

clearCache()

Clears all previously loaded API objects.


    public
            static        clearCache() : mixed

Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.

createMessageFolder()

Creates a new message folder. It returns false if the record already exists and the id if it is able to create the folder


    public
                    createMessageFolder(mixed $folderName) : int

Parameters

$folderName : mixed

Return values

int

createQuoteText()

This returns the text to quote a node. Used initially for private messaging.


    public
                    createQuoteText(mixed $nodeid, mixed $pageText) : string

Parameters

$nodeid : mixed
$pageText : mixed

Return values

string —

Quote text.

delete()

Permanently deletes a node


    public
                    delete(mixed $nodeid) : bool

Parameters

$nodeid : mixed

Return values

bool

deleteFolder()

Deletes a folder and moves its contents to trash


    public
                    deleteFolder(mixed $folderid) : mixed

Parameters

$folderid : mixed

deleteMessage()

Permanently deletes a message


    public
                    deleteMessage(mixed $nodeid) : bool

Parameters

$nodeid : mixed

Return values

bool —

did the deletion succeed?

deleteMessages()

Delete private messages. Once deleted user won't be able to retrieve them again.


    public
                    deleteMessages(mixed $nodeid) : array<string|int, mixed>

Parameters

$nodeid : mixed

Return values

array<string|int, mixed> —

Whether delete action succeeded or not. keys -- success

deleteMessagesForUser()

Deletes all pms for a given user


    public
                    deleteMessagesForUser(int $userid) : array<string|int, mixed>

This will mark all "sentto" records for the given user as deleted. In addtion it will mark any PM records for deletion that no longer have any users attached to them. The actual deletion is handled via cron script.

The requested user must much the current user or the current use have the 'canadminusers' permission

Parameters

$userid : int

Return values

array<string|int, mixed> —

'deleted' int -- number of items marked for delete (for the user, the pm itself might be referenced by another user and therefore still around)

deleteSentMessagesForUser()

Deletes all pms for a given user


    public
                    deleteSentMessagesForUser(int $userid) : array<string|int, mixed>

This will mark all "sentto" records for PM nodes sent by the given user as deleted. In addtion it will mark any PM records for deletion that no longer have any users attached to them. The actual deletion is handled via cron script.

The the current user must have the 'canadminusers' permission. (This deletes things from other people's inboxes so we don't want to allow normal users to use it)

Parameters

$userid : int

Return values

array<string|int, mixed> —

'deleted' int -- number of items marked for delete (for the user, the pm itself might be referenced by another user and therefore still around)

denyRequest()

Denies a user follow request


    public
                    denyRequest(mixed $nodeid[, mixed $cancelRequestFor = 0 ]) : array<string|int, mixed>

Parameters

$nodeid : mixed
$cancelRequestFor : mixed = 0

Return values

array<string|int, mixed> —

array('result' => resultphrase) if resultphrase is empty, there is nothing useful to say about what happened

extractMedia()

Extracts the video and photo content from text.


    public
                    extractMedia(mixed $rawtext) : mixed

Parameters

$rawtext : mixed

Return values

mixed —

Array of "photo", "video". Each is an array of images.

fetchFolders()

Returns the cached folder information


    public
                    fetchFolders(mixed $userid) : mixed

Parameters

$userid : mixed

Return values

mixed —

Array containing user folders info.

fetchParticipants()

Returns an array of all users participating in a discussion


    public
                    fetchParticipants(mixed $nodeid) : array<string|int, mixed>

Parameters

$nodeid : mixed

Return values

array<string|int, mixed> —

of user information

following -- is the participant a follower of the current user (may be NULL)
userid -- ID of the participant
username -- Name of the participant
avatarurl -- Url for the participant's avatar
starter -- ID of the starter for $nodeid

fetchSummary()

Returns a summary of messages for current user


    public
                    fetchSummary() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of information including: folderId, title, quantity not read.

fetchTableName()

Returns the tables used by this content type.


    public
                    fetchTableName() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array of table names

getApiClassName()


    public
            static        getApiClassName(mixed $controller) : mixed

Parameters

$controller : mixed

getAutoparseLinks()

Returns the autoparselinks setting. In the public API for createcontent getPreview() use, not really meant for regular usage.


    public
                    getAutoparseLinks(mixed $data) : mixed

Parameters

$data : mixed: Input array similar to what would be passed into content_text::text() expected: htmlstate, disable_bbcode, parentid

Return values

mixed —

['autoparselinks' => (bool)]

getBareContent()

Returns the node content, channel routeid and title, and starter route and title, but no permissions or other subsidiary data


    public
                    getBareContent(mixed $nodeid[, mixed $permissions = false ]) : mixed

Parameters

$nodeid : mixed
$permissions : mixed = false

getBbcodeOptions()

Returns an array with bbcode options for PMs


    public
                    getBbcodeOptions([mixed $nodeid = 0 ]) : array<string|int, mixed>

Parameters

$nodeid : mixed = 0

Return values

array<string|int, mixed> —

Options

getContent()

Alias for @getFullContent


    public
                    getContent(mixed $nodeid[, mixed $permissions = false ]) : mixed

Parameters

$nodeid : mixed
$permissions : mixed = false

getContentApi()

Returns a content api of the appropriate type


    public
            static        getContentApi(mixed $contenttypeid) : mixed

Parameters

$contenttypeid : mixed

Return values

mixed —

Content api object

getConversationParent()

Gets the conversation starter for a node. If the node is a channel it returns the channel array.


    public
                    getConversationParent(int $nodeid) : array<string|int, mixed>|false

Parameters

$nodeid : int

Return values

array<string|int, mixed>|false —

The starter node array. False when the node lookup fails

getDataForParse()

Gets the data the presentation layer needs to have to parse the rawtext.


    public
                    getDataForParse(mixed $nodeIds) : array<string|int, mixed>

Parameters

$nodeIds : mixed

Return values

array<string|int, mixed> —

Array of node information for parsing the content. Each item indexed by the nodeid and contains: 'bbcodeoptions', 'rawtext', 'previewtext', 'attachments', 'title' 'channelid', 'htmlstate', 'disable_bbcode', 'avatar_userids'

getDeletedItemsFolderId()

Gets the deleted_items folder id


    public
                    getDeletedItemsFolderId() : int

Return values

int —

The deleted_items folder id from messagefolder.

getFolderInfoFromId()

Gets the folder information from a given folderid. The folderid requested should belong to the user who is requesting.


    public
                    getFolderInfoFromId(mixed $folderid) : array<string|int, mixed>

Parameters

$folderid : mixed

Return values

array<string|int, mixed> —

The folder information such as folder title, titlephrase and if is custom folder.

getFolderMsgCount()

Gets the count of undeleted messages in a folder


    public
                    getFolderMsgCount(int $folderid[, int $pageNum = 1 ][, int $perpage = 50 ][, string $about = false ][, array<string|int, mixed> $filterParams = false ]) : array<string|int, mixed>

Parameters

$folderid : int

the folderid to search

$pageNum : int = 1

$perpage : int = 50

$about : string = false

Optional "about" string

$filterParams : array<string|int, mixed> = false

Optional filter parameters, only used for notifications. See vB_Library_Notification::fetchNotificationsForCurrentUser()

'sortDir'
'perpage'
'page'
'showdetail'
'about'

Return values

array<string|int, mixed> —

the count & page data, including: 'count', 'pages' (total pages), 'pagenum' (selected page #), 'nextpage', 'prevpage'

getForward()

Gets the title and forward


    public
                    getForward(string|array<string|int, mixed> $nodeids) : array<string|int, mixed>

Parameters

$nodeids : string|array<string|int, mixed>: -- will accept an array, but normally a comma-delimited string

Return values

array<string|int, mixed> —

of first (single db record), messages- nodeid=> [title, recipents(string], to (array of names), pagetext, date)

getFullContent()

Returns the node content as an associative array


    public
                    getFullContent(int $nodeid[, mixed $permissions = false ]) : array<string|int, mixed>

Parameters

$nodeid : int
$permissions : mixed = false

Return values

array<string|int, mixed>

getHeaderCounts()

Gets the count of unread messages, requests, & notifications for regular users, and also pending posts & reports for admins and moderators with access.


    public
                    getHeaderCounts() : array<string|int, mixed>

Return values

array<string|int, mixed> —

with keys 'title', 'count', 'details' where keys are: 'titlephrase' : string phrase title for header bar 'totalcount' : int total count for header bar

'details' : array subdivisions of the total count with keys 'messages', 'requests', 'your_notifications', and possibly: 'pending_posts', 'reports' where each key points to an array of 'titlephrase' => string phrase title for this folder 'count' => int unread count for this folder 'routeinfo' => array routeinfo for generating links <for vB Messenger> 'messages' : int pm counts only 'folderid_messages' : int folderid of messages folder.

getInfractionFolderId()

Gets the infractions folder id


    public
                    getInfractionFolderId() : int

Return values

int —

The infractions folder id from messagefolder.

getMessage()

Gets a message


    public
                    getMessage(int $nodeid) : array<string|int, mixed>

Parameters

$nodeid : int

Return values

array<string|int, mixed>

getOpenReportsCount()

Gets the count of open reports


    public
                    getOpenReportsCount() : int

Return values

int —

the count of open reports

getPendingPostFolderId()

Gets the pending posts folder id


    public
                    getPendingPostFolderId() : int

Return values

int —

The pending posts folder id from messagefolder.

getQuotes()

Returns a string with quoted strings in bbcode format.


    public
                    getQuotes(mixed $nodeids) : string

Parameters

$nodeids : mixed

Return values

string

getQuoteText()

This returns the text to quote a node. Used initially for private messaging.


    public
                    getQuoteText(mixed $nodeid) : string

Parameters

$nodeid : mixed

Return values

string —

Quote text

getReplyText()

Returns the text for a "reply" or "forward" message. Not implemented yet


    public
                    getReplyText(mixed $nodeid) : mixed

Parameters

$nodeid : mixed

getRequest()

Get a single request


    public
                    getRequest(mixed $nodeid) : array<string|int, mixed>

Parameters

$nodeid : mixed

Return values

array<string|int, mixed> —

The node data array for the request

getSearchJSON()

Returns a formatted json string appropriate for the search api interface


    public
                    getSearchJSON(mixed $queryText) : string

Parameters

$queryText : mixed

Return values

string —

the json string

getTextCountChange()

Returns textCountChange property


    public
                    getTextCountChange() : int

Return values

int

getTimeNow()

Gives the current board time- needed to set publishdate.


    public
                    getTimeNow() : int

Return values

int

getUnreadInboxCount()

Gets the count of undeleted messages & notifications


    public
                    getUnreadInboxCount() : int

Return values

int —

the count

instance()

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.


    public
            static        instance(string $controller[, bool $refresh_cache = false ]) : vB_Api

Parameters

$controller : string: -- name of the API controller to load
$refresh_cache : bool = false: -- true if we want to force the cache to update with a new api object primarily intended for testing

Return values

vB_Api

instanceInternal()

Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API


    public
            static        instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api

Parameters

$controller : string: -- name of the API controller to load
$refresh_cache : bool = false: -- true if we want to force the cache to update with a new api object primarily intended for testing

Return values

vB_Api

isPublished()

Determines if this record is in a published state


    public
                    isPublished(mixed $data) : bool

Parameters

$data : mixed

Return values

bool

isVisitorMessage()

Determines whether a specific node is a visitor message


    public
                    isVisitorMessage(mixed $nodeid) : bool

Parameters

$nodeid : mixed

Return values

bool

listFolders()

Lists the folders.


    public
                    listFolders([mixed $suppress = [] ]) : array<string|int, mixed>

Parameters

$suppress : mixed = []

Return values

array<string|int, mixed> —

of folderid => title

listMessages()

Lists messages for current user


    public
                    listMessages([array<string|int, mixed> $data = array() ]) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed> = array(): 'sortDir' 'pageNum' 'perpage' 'folderid' 'showdeleted' 'ignoreRecipients'

Return values

array<string|int, mixed> —

list of messages.

listNotifications()

Lists notifications for current user


    public
                    listNotifications([mixed $data = array() ]) : array<string|int, mixed>

Parameters

$data : mixed = array()

Return values

array<string|int, mixed> —

@see vB_Library_Notification::fetchNotificationsforCurrentUser()

listRequests()

Lists messages for current user


    public
                    listRequests([mixed $data = array() ]) : mixed

Parameters

$data : mixed = array()

Return values

mixed —

array-includes folderId, title, quantity not read. Also 'page' is array of node records for page 1.

map_vb4_input_to_vb5()

Returns vb5 api method name.


    public
            static        map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string

May alter request array.

Parameters

$method : string: -- vb4 method name
$request : array<string|int, mixed>: -- $_REQUEST array for this api request

Return values

string

map_vb5_errors_to_vb4()

Alters the error array in any way necessary to interface correctly with vb4.


    public
            static        map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed

Parameters

$method : string: -- vb4 method name
$data : array<string|int, mixed>: -- error array from vb5

map_vb5_output_to_vb4()

Alters the output array in any way necessary to interface correctly with vb4.


    public
            static        map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed

Parameters

$method : string: -- vb4 method name
$data : array<string|int, mixed>: -- output array from vb5

moveMessage()

Moves a message to a different folder


    public
                    moveMessage(mixed $nodeid[, mixed $newFolderid = false ]) : bool

Parameters

$nodeid : mixed
$newFolderid : mixed = false

Return values

bool —

did it succeed?

previewMessages()

Gets the preview for the messages


    public
                    previewMessages() : mixed

Return values

mixed —

array of record-up to five each messages, then requests, then notifications

resetFolders()

Clears the cached folder information


    public
                    resetFolders() : mixed

setRead()

Sets a message to read


    public
                    setRead(int $nodeid[, int $read = 1 ]) : standard

Parameters

$nodeid : int
$read : int = 1: -- 1 is read / 0 is unread

Return values

standard —

success array

toTrashcan()

Moves a node to the trashcan. Wrapper for deleteMessage()


    public
                    toTrashcan(mixed $nodeid) : mixed

Parameters

$nodeid : mixed

undeleteMessage()

Moves a message back to user inbox folder


    public
                    undeleteMessage(mixed $nodeid) : bool

Parameters

$nodeid : mixed

Return values

bool —

True if succesfully done.

update()

Updates a record


    public
                    update(mixed $nodeid, mixed $data) : bool

Parameters

$nodeid : mixed
$data : mixed

Return values

bool

updateFolderTitle()

Updates the title


    public
                    updateFolderTitle(mixed $folderName, mixed $folderid) : array<string|int, mixed>

Parameters

$folderName : mixed
$folderid : mixed

Return values

array<string|int, mixed> —

The array of folder information for this folder.

vB_Api_Content_Privatemessage extends vB_Api_Content_Text in package vBApi

Table of Contents

Constants

Methods

Constants

PARTICIPANTS_CHANNEL

PARTICIPANTS_PM

PARTICIPANTS_POLL

Methods

__serialize()

Return values

__sleep()

Return values

__unserialize()

Parameters

__wakeup()

acceptRequest()

Parameters

Return values

add()

Parameters

Return values

addPMRecipients()

Parameters

addPMRecipientsByUsernames()

Parameters

autoPopulatePreviewImage()

Parameters

Tags

buildPmTotals()

Parameters

callNamed()

Return values

canUsePmSystem()

Parameters

Return values

checkApiState()

Parameters

checkFolders()

Parameters

cleanInput()

Parameters

cleanPreviewContent()

Parameters

clearCache()

createMessageFolder()

Parameters

Return values

createQuoteText()

Parameters

Return values

delete()

Parameters

Return values

deleteFolder()

Parameters

deleteMessage()

Parameters

Return values

deleteMessages()

Parameters

Tags

Return values

deleteMessagesForUser()

Parameters

Tags

Return values

deleteSentMessagesForUser()

Parameters

Tags

Return values

denyRequest()

Parameters

Return values

extractMedia()

Parameters

Return values

fetchFolders()

Parameters

Return values

vB_Api_Content_Privatemessage extends vB_Api_Content_Text
in package

vBApi