PlatformService/PlatformService.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\PlatformService

Package: Default
This file contains Intuit Platform services.

Properties

>VPropertyprivate\unknown $requestXmlDocument
Request Xml Document
Details
Type
\unknown
>VPropertypublic\RequestHandler $restRequestHandler
The Rest request handler object.
Details
Type
\RequestHandler
>VPropertypublic\ServiceContext $serviceContext
The Service context object.
Details
Type
\ServiceContext

Methods

methodpublicCurrentUser() : \SimpleXMLElement

Returns user information such as first name, last name, and email address.

Returns
TypeDescription
\SimpleXMLElementXml of Disconnect response
methodpublicDisconnect() : \SimpleXMLElement

Disconnect invalidates the OAuth access token in the request, thereby disconnecting the user from QuickBooks for this app.

Returns
TypeDescription
\SimpleXMLElementXml of Disconnect response
methodpublicGetAppMenu() : string

Get App Menu

Returns
TypeDescription
stringHtml of App Menu
methodpublicReconnect() : \SimpleXMLElement

Reconnect generates a new OAuth access token and invalidates the OAuth access token used in the request, thereby extending the life span by six months.

Returns
TypeDescription
\SimpleXMLElementXml of Reconnect response
methodpublic__construct( $serviceContext) : void

Initializes a new instance of the PlatformService class.

Parameters
NameTypeDescription
$serviceContext
Throws
ExceptionDescription
\ArgumentException:The exception that is thrown when one of the argument(s) provided to a method is not valid.
\InvalidTokenException:When invalid tokens are passed.
\ArgumentNullException:When Service context parameter sent as null.
Documentation was generated by phpDocumentor 2.8.5.