We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Commit e8526b2e authored by Brion Vibber's avatar Brion Vibber

More doc comments on SN_YammerClient

parent 472dab4a
...@@ -139,8 +139,11 @@ class SN_YammerClient ...@@ -139,8 +139,11 @@ class SN_YammerClient
} }
/** /**
* Encode a key-value pair for use in an authentication header.
*
* @param string $key * @param string $key
* @param string $val * @param string $val
* @return string
*/ */
protected function authHeaderChunk($key, $val) protected function authHeaderChunk($key, $val)
{ {
...@@ -148,6 +151,9 @@ class SN_YammerClient ...@@ -148,6 +151,9 @@ class SN_YammerClient
} }
/** /**
* Ask the Yammer server for a request token, which can be passed on
* to authorizeUrl() for the user to start the authentication process.
*
* @return array of oauth return data; should contain nice things * @return array of oauth return data; should contain nice things
*/ */
public function requestToken() public function requestToken()
...@@ -162,6 +168,9 @@ class SN_YammerClient ...@@ -162,6 +168,9 @@ class SN_YammerClient
} }
/** /**
* Get a final access token from the verifier/PIN code provided to
* the user from Yammer's auth pages.
*
* @return array of oauth return data; should contain nice things * @return array of oauth return data; should contain nice things
*/ */
public function accessToken($verifier) public function accessToken($verifier)
...@@ -175,7 +184,7 @@ class SN_YammerClient ...@@ -175,7 +184,7 @@ class SN_YammerClient
} }
/** /**
* Give the URL to send users to to authorize a new app setup * Give the URL to send users to to authorize a new app setup.
* *
* @param string $token as returned from accessToken() * @param string $token as returned from accessToken()
* @return string URL * @return string URL
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment