node-nicovideo-api

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>NicoMyListApi</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: </em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/CommentProvider.html">CommentProvider</a></li> <li><a href="../classes/MyListItem.html">MyListItem</a></li> <li><a href="../classes/MyListMeta.html">MyListMeta</a></li> <li><a href="../classes/NicoMyListApi.html">NicoMyListApi</a></li> <li><a href="../classes/NicoVideoApi.html">NicoVideoApi</a></li> <li><a href="../classes/NicoVideoInfo.html">NicoVideoInfo</a></li> <li><a href="../classes/NsenChannel.html">NsenChannel</a></li> </ul> <ul id="api-modules" class="apis modules"> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>NicoMyListApi Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/src_mylist_NicoMyListApi.coffee.html#l38"><code>src/mylist/NicoMyListApi.coffee:38</code></a> </div> </div> <div class="box intro"> <p>ニコニコ動画のマイリスト操作APIのラッピングを行います。（参考: <a href="http://efcl.info/wiki/niconicoapi/%EF%BC%89">http://efcl.info/wiki/niconicoapi/）</a></p> </div> <div class="constructor"> <h2>Constructor</h2> <div id="method_NicoMyListApi" class="method item"> <h3 class="name"><code>NicoMyListApi</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>session</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l38"><code>src/mylist/NicoMyListApi.coffee:38</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">session</code> <span class="type">NicoSession</span> <div class="param-description"> </div> </li> </ul> </div> </div> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_fetchMyList">fetchMyList</a> </li> <li class="index-item method"> <a href="#method_fetchMyListsIndex">fetchMyListsIndex</a> </li> <li class="index-item method"> <a href="#method_fetchToken">fetchToken</a> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property private"> <a href="#property__session">_session</a> </li> <li class="index-item property private"> <a href="#property__token">_token</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_fetchMyList" class="method item"> <h3 class="name"><code>fetchMyList</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>id</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Promise(MyList, string)</span> </span> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l113"><code>src/mylist/NicoMyListApi.coffee:113</code></a> </p> </div> <div class="description"> <p>MyListインスタンスを取得します。</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">id</code> <span class="type">MyListItemIndex | Number</span> <div class="param-description"> <p>MyListItemIndexかマイリストIDを渡します。</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Promise(MyList, string)</span>: <p>取得できればMyListオブジェクトと共にresolveされ、そうでなければエラーメッセージと共にrejectされます</p> </div> </div> </div> <div id="method_fetchMyListsIndex" class="method item"> <h3 class="name"><code>fetchMyListsIndex</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>withoutHome</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Promise</span> </span> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l77"><code>src/mylist/NicoMyListApi.coffee:77</code></a> </p> </div> <div class="description"> <p>マイリストの一覧を取得します。</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">withoutHome</code> <span class="type">Boolean</span> <div class="param-description"> <p>trueを指定すると"とりあえずマイリスト"を一覧から除外します。</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Promise</span>: <ul> <li>resolve : (mylists: Array.<MyListItemIndex>)</li> <li>reject : (message: String)</li> </ul> </div> </div> </div> <div id="method_fetchToken" class="method item"> <h3 class="name"><code>fetchToken</code></h3> <span class="paren">()</span> <span class="returns-inline"> <span class="type">Promise</span> </span> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l49"><code>src/mylist/NicoMyListApi.coffee:49</code></a> </p> </div> <div class="description"> <p>マイリストを操作するための認証トークンを取得します。</p> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Promise</span>: </div> </div> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property__session" class="property item private"> <h3 class="name"><code>_session</code></h3> <span class="type">NicoSession</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l24"><code>src/mylist/NicoMyListApi.coffee:24</code></a> </p> </div> <div class="description"> </div> </div> <div id="property__token" class="property item private"> <h3 class="name"><code>_token</code></h3> <span class="type">Object</span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_mylist_NicoMyListApi.coffee.html#l29"><code>src/mylist/NicoMyListApi.coffee:29</code></a> </p> </div> <div class="description"> <p>認証トークン</p> </div> <h4>Sub-properties:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">timestamp</code> <span class="type">Number</span> <div class="param-description"> <p>トークンを取得した時間（ミリ秒）</p> </div> </li> <li class="param"> <code class="param-name">token</code> <span class="type">String</span> <div class="param-description"> <p>マイリスト操作用トークン</p> </div> </li> </ul> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>