You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><meta name="theme-color" content="#375EAB">
<title>hipchat - The Go Programming Language</title>
<link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
<link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css"><script type="text/javascript">window.initFuncs = [];</script></head><body>
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">...</div><!-- #lowframe -->
<div id="topbar" class="wide"><div class="container"><div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div><div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div><a href="index.html#" id="menu-button"><span id="menu-button-arrow">▽</span></a><form method="GET" action="http://localhost:6060/search"><div id="menu"><a href="http://localhost:6060/doc/">Documents</a><a href="http://localhost:6060/pkg/">Packages</a><a href="http://localhost:6060/project/">The Project</a><a href="http://localhost:6060/help/">Help</a><a href="http://localhost:6060/blog/">Blog</a>
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search"></div></form>
</div></div>
<div id="page" class="wide"><div class="container">
<h1>Package hipchat</h1>
<div id="nav"></div>
<!--
Copyright 2009 The Go Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.--><!--
Note: Static (i.e., not template-generated) href and id attributes start with "pkg-" to make it impossible for them to conflict with generated attributes (some of which correspond to Go identifiers).-->
<script type='text/javascript'> document.ANALYSIS_DATA = null; document.CALLGRAPH = null; </script>
<div id="short-nav"> <dl> <dd><code>import "golang.org/x/oauth2/hipchat"</code></dd> </dl> <dl> <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd> <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd> </dl> </div> <!-- The package's Name is printed as title by the top-level template --> <div id="pkg-overview" class="toggleVisible"> <div class="collapsed"> <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2> </div> <div class="expanded"> <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2> <p>Package hipchat provides constants for using OAuth2 to access HipChat.</p>
</div> </div>
<div id="pkg-index" class="toggleVisible"> <div class="collapsed"> <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2> </div> <div class="expanded"> <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. --> <div id="manual-nav"> <dl> <dd><a href="index.html#pkg-variables">Variables</a></dd> <dd><a href="index.html#ClientCredentialsConfigFromCaps">func ClientCredentialsConfigFromCaps(capsJSON []byte, clientID, clientSecret string, scopes ...string) (*clientcredentials.Config, error)</a></dd> <dd><a href="index.html#ServerEndpoint">func ServerEndpoint(host string) oauth2.Endpoint</a></dd> </dl> </div><!-- #manual-nav -->
<h4>Package files</h4> <p> <span style="font-size:90%"> <a href="http://localhost:6060/src/golang.org/x/oauth2/hipchat/hipchat.go">hipchat.go</a> </span> </p> </div><!-- .expanded --> </div><!-- #pkg-index -->
<div id="pkg-callgraph" class="toggle" style="display: none"> <div class="collapsed"> <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2> </div> <!-- .expanded --> <div class="expanded"> <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2> <p> In the call graph viewer below, each node is a function belonging to this package and its children are the functions it calls—perhaps dynamically. </p> <p> The root nodes are the entry points of the package: functions that may be called from outside the package. There may be non-exported or anonymous functions among them if they are called dynamically from another package. </p> <p> Click a node to visit that function's source code. From there you can visit its callers by clicking its declaring <code>func</code> token. </p> <p> Functions may be omitted if they were determined to be unreachable in the particular programs or tests that were analyzed. </p> <!-- Zero means show all package entry points. --> <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul> </div> </div> <!-- #pkg-callgraph -->
<h2 id="pkg-variables">Variables</h2> <pre>var <span id="Endpoint">Endpoint</span> = <a href="../index.html">oauth2</a>.<a href="../index.html#Endpoint">Endpoint</a>{ <a href="index.html#AuthURL">AuthURL</a>: "https://www.hipchat.com/users/authorize", <a href="index.html#TokenURL">TokenURL</a>: "https://api.hipchat.com/v2/oauth/token",}</pre> <p>Endpoint is HipChat's OAuth 2.0 endpoint.</p>
<h2 id="ClientCredentialsConfigFromCaps">func <a href="http://localhost:6060/src/golang.org/x/oauth2/hipchat/hipchat.go?s=1158:1295#L26">ClientCredentialsConfigFromCaps</a></h2> <pre>func ClientCredentialsConfigFromCaps(capsJSON []<a href="../../../../builtin/index.html#byte">byte</a>, clientID, clientSecret <a href="../../../../builtin/index.html#string">string</a>, scopes ...<a href="../../../../builtin/index.html#string">string</a>) (*<a href="../clientcredentials/index.html">clientcredentials</a>.<a href="../clientcredentials/index.html#Config">Config</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre> <p>ClientCredentialsConfigFromCaps generates a Config from a HipChat APIcapabilities descriptor. It does not verify the scopes against thecapabilities document at this time.</p><p>For more information see: <a href="https://www.hipchat.com/docs/apiv2/method/get_capabilities">https://www.hipchat.com/docs/apiv2/method/get_capabilities</a></p>
<h2 id="ServerEndpoint">func <a href="http://localhost:6060/src/golang.org/x/oauth2/hipchat/hipchat.go?s=700:748#L14">ServerEndpoint</a></h2> <pre>func ServerEndpoint(host <a href="../../../../builtin/index.html#string">string</a>) <a href="../index.html">oauth2</a>.<a href="../index.html#Endpoint">Endpoint</a></pre> <p>ServerEndpoint returns a new oauth2.Endpoint for a HipChat Server instancerunning on the given domain or host.</p>
<div id="footer">Build version go1.6.<br>Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,the content of this page is licensed under theCreative Commons Attribution 3.0 License,and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br><a href="http://localhost:6060/doc/tos.html">Terms of Service</a> | <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a></div>
</div><!-- .container --></div><!-- #page -->
<!-- TODO(adonovan): load these from <head> using "defer" attribute? --><script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script><script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script><script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
<script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
</body></html>
|
