node-nicovideo-api
Version:
nicovideo api (video, live, etc..) wrapper package for node.js
567 lines (381 loc) • 16 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>MyListItem</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>MyListItem Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_mylist_MyListItem.coffee.html#l1"><code>src/mylist/MyListItem.coffee:1</code></a>
</div>
</div>
<div class="box intro">
<p>マイリストの項目モデルです。</p>
<p>Properties
getメソッドを通じて第1階層まで取得できます。
Example. mylistItem.get("movie").title</p>
<ul>
<li>id : number -- マイリスト項目ID</li>
<li>type : number -- 項目の種類(動画、静画など)</li>
<li>description : string -- マイリストコメント</li>
<li>createTime : Date -- 追加日</li>
<li>updateTime : Date -- 更新日(?)</li>
<li>watch : number -- 不明</li>
<li>movie : Object -- 動画情報
<ul>
<li>
<p>id : string -- 動画ID</p>
</li>
<li>
<p>title : string -- 動画タイトル</p>
</li>
<li>
<p>length : number -- 動画の長さ(秒)</p>
</li>
<li>
<p>thumbnail : string -- サムネイル画像のURL</p>
</li>
<li>
<p>groupType : string -- 不明</p>
</li>
<li>
<p>lastResponse : string -- 最近投稿されたコメントの一部</p>
</li>
<li>
<p>isDeleted : boolean -- 削除されているか</p>
</li>
<li>
<p>updateTime : Date -- この情報の最終更新日時(?)</p>
</li>
<li>
<p>firtsRetrieve : Date -- 動画投稿日</p>
</li>
<li>
<p>count -- カウンタ系の情報が詰められたオブジェクト</p>
<ul>
<li>view : number -- 再生数</li>
<li>comments : number -- コメント数</li>
<li>mylist : number -- マイリスト数</li>
</ul>
</li>
</ul>
</li>
</ul>
</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_fronApiResponse">fronApiResponse</a>
<span class="flag static">static</span>
</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__attr">_attr</a>
</li>
<li class="index-item property private">
<a href="#property__attr マイリスト情報">_attr マイリスト情報</a>
</li>
<li class="index-item property private">
<a href="#property__session セッション">_session セッション</a>
</li>
<li class="index-item property private">
<a href="#property__urlSet MyList APIのurl">_urlSet MyList APIのurl</a>
</li>
<li class="index-item property">
<a href="#property_id">id</a>
</li>
<li class="index-item property">
<a href="#property_items 登録されている動画のリスト">items 登録されている動画のリスト</a>
</li>
<li class="index-item property">
<a href="#property_ItemTypes アイテムの種類のリスト">ItemTypes アイテムの種類のリスト</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_list">list</a>
</li>
<li class="index-item property">
<a href="#property_{MyListItem} item">{MyListItem} item</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_fronApiResponse" class="method item">
<h3 class="name"><code>fronApiResponse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>itemInfo</code>
</li>
<li class="arg">
<code>mylist</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyListItem.coffee.html#l67"><code>src/mylist/MyListItem.coffee:67</code></a>
</p>
</div>
<div class="description">
<p>MylistAPIの取得結果の一部からMyListItemのオブジェクトを生成します。</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">itemInfo</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">mylist</code>
<span class="type">MyList</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__attr" class="property item private">
<h3 class="name"><code>_attr</code></h3>
<span class="type">Object</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyListItem.coffee.html#l117"><code>src/mylist/MyListItem.coffee:117</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property__attr マイリスト情報" class="property item private">
<h3 class="name"><code>_attr マイリスト情報</code></h3>
<span class="type">Object</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyList.coffee.html#l84"><code>src/mylist/MyList.coffee:84</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<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_MyList.coffee.html#l72"><code>src/mylist/MyList.coffee:72</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property__urlSet MyList APIのurl" class="property item private">
<h3 class="name"><code>_urlSet MyList APIのurl</code></h3>
<span class="type">Object</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyList.coffee.html#l78"><code>src/mylist/MyList.coffee:78</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_id" class="property item">
<h3 class="name"><code>id</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyListItem.coffee.html#l122"><code>src/mylist/MyListItem.coffee:122</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_items 登録されている動画のリスト" class="property item">
<h3 class="name"><code>items 登録されている動画のリスト</code></h3>
<span class="type">Array.<MyListItem></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyList.coffee.html#l90"><code>src/mylist/MyList.coffee:90</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_ItemTypes アイテムの種類のリスト" class="property item">
<h3 class="name"><code>ItemTypes アイテムの種類のリスト</code></h3>
<span class="type">Object</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyListItem.coffee.html#l45"><code>src/mylist/MyListItem.coffee:45</code></a>
</p>
</div>
<div class="description">
</div>
<h4>Sub-properties:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ItemTypes.movie</code>
<span class="type">Number</span>
<div class="param-description">
<p>動画</p>
</div>
</li>
<li class="param">
<code class="param-name">ItemTypes.seiga</code>
<span class="type">Number</span>
<div class="param-description">
<p>静画</p>
</div>
</li>
</ul>
</div>
<div id="property_list" class="property item">
<h3 class="name"><code>list</code></h3>
<span class="type">MyList</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyList.coffee.html#l59"><code>src/mylist/MyList.coffee:59</code></a>
</p>
</div>
<div class="description">
<p>マイリストが最新の内容に更新された時に発火します</p>
</div>
</div>
<div id="property_{MyListItem} item" class="property item">
<h3 class="name"><code>{MyListItem} item</code></h3>
<span class="type">MyList</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_mylist_MyList.coffee.html#l65"><code>src/mylist/MyList.coffee:65</code></a>
</p>
</div>
<div class="description">
<p>マイリストから項目が削除された時に発火します</p>
</div>
</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>