Public Member Functions | Protected Attributes

FacebookApiException Class Reference

Inheritance diagram for FacebookApiException:
Collaboration diagram for FacebookApiException:

List of all members.

Public Member Functions

 __construct ($result)
 getResult ()
 getType ()
 __toString ()

Protected Attributes

 $result

Detailed Description

Copyright 2011 Facebook, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Thrown when an API call returns an exception.

Author:
Naitik Shah <[email protected]>

Definition at line 30 of file base_facebook.php.


Constructor & Destructor Documentation

FacebookApiException.__construct ( result  ) 

Make a new API Exception with the given result.

Parameters:
array $result The result from the API server

Definition at line 42 of file base_facebook.php.


Member Function Documentation

FacebookApiException.__toString (  ) 

To make debugging easier.

Returns:
string The string representation of the error

Definition at line 100 of file base_facebook.php.

FacebookApiException.getResult (  ) 

Return the associated result object returned by the API server.

Returns:
array The result from the API server

Definition at line 68 of file base_facebook.php.

FacebookApiException.getType (  ) 

Returns the associated type for the error. This will default to 'Exception' when a type is not available.

Returns:
string

Definition at line 78 of file base_facebook.php.


Member Data Documentation

FacebookApiException.$result [protected]

The result from the API server that represents the exception information.

Definition at line 35 of file base_facebook.php.


The documentation for this class was generated from the following file: