Parent

Files

RFacebook::FacebookSession

Deprecated Methods ↑ top

Error classes ↑ top

Properties ↑ top

Attributes

logger[RW]

Can be set to any valid logger (for example, RAIL_DEFAULT_LOGGER)

session_expires[R]

The expiration time of this session, as given from Facebook API login.

session_key[R]

The key for this session. You will need to save this for infinite sessions.

session_user_id[R]

The user id of the user associated with this sesssion.

Public Interface ↑ top

Public Class Methods

new(api_key, api_secret, quiet = false) click to toggle source

Constructs a FacebookSession.

api_key

your API key

api_secret

your API secret

quiet

boolean, set to true if you don't want exceptions to be thrown (defaults to false)

# File lib/facebook_session.rb, line 95
def initialize(api_key, api_secret, quiet = false)
  # required parameters
  @api_key = api_key
  @api_secret = api_secret
    
  # optional parameters
  @quiet = quiet

  # initialize internal state
  @last_error_message = nil # DEPRECATED
  @last_error_code = nil # DEPRECATED
  @expired = false
end

Public Instance Methods

expired?() click to toggle source

Returns true if the session is expired (will often mean that the session is not ready as well)

# File lib/facebook_session.rb, line 115
def expired?
  return @expired
end
quiet=(val) click to toggle source

Sets whether or not we suppress exceptions from being thrown

# File lib/facebook_session.rb, line 125
def quiet=(val)
  @quiet = val
end
quiet?() click to toggle source

Returns true if exceptions are being suppressed in favor of log messages

# File lib/facebook_session.rb, line 120
def quiet?
  return @quiet
end
ready?() click to toggle source

Template method. Returns true when the session is definitely prepared to make API calls.

# File lib/facebook_session.rb, line 110
def ready?
  raise NotImplementedError
end
signature(params) click to toggle source

Template method. Used for signing a set of parameters in the way that Facebook specifies: <developers.facebook.com/documentation.php?v=1.0&doc=auth>

params

a Hash containing the parameters to sign

# File lib/facebook_session.rb, line 133
def signature(params)
  raise NotImplementedError
end

Serialization ↑ top

Utility methods ↑ top

[Validate]

Generated with the Darkfish Rdoc Generator 2.