search-nico-js Class: ContentsSearchRequest

new ContentsSearchRequest()

コンテンツ検索リクエストのコンストラクタ

Source:

search-nico.js

Methods

equalFilter(field, value) → {ContentsSearchRequest}

equalフィルタオブジェクトを生成する

Parameters:

Name	Type	Description
`field`	String	フィルタ対象フィールド
`value`	String/Number	フィルタ対象の値

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

fetch() → {Promise}

検索リクエストのプロミスオブジェクトを取得する

Source:

search-nico.js

Returns:

プロミスオブジェクト - resolve/reject関数がプロミスの成功または失敗に応じて呼ばれる

Type: Promise

filter(filters) → {ContentsSearchRequest}

フィルタ条件を設定する

Parameters:

Name	Type	Description
`filters`	Array	フィルタ条件リスト

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

from(from) → {ContentsSearchRequest}

検索結果の取得開始位置を設定する

Parameters:

Name	Type	Description
`from`	Number	検索結果の取得開始位置

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

keyword(keyword) → {ContentsSearchRequest}

検索キーワードを設定する

Parameters:

Name	Type	Description
`keyword`	String	検索キーワード

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

rangeFilter(field, from, to, includeUpper, includeLower) → {ContentsSearchRequest}

rangeフィルタオブジェクトを生成する

Parameters:

Name	Type	Description
`field`	String	フィルタ対象フィールド
`from`	String/Number	開始値
`to`	String/Number	終了値
`includeUpper`	Boolean	上限値を含むかどうか
`includeLower`	Boolean	下限値を含むかどうか

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

select(names) → {ContentsSearchRequest}

検索結果に含めるフィールドを設定する

Parameters:

Name	Type	Description
`names`	Array	取得対象のフィールドリスト

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

service(name) → {ContentsSearchRequest}

検索対象サービスを設定する

Parameters:

Name	Type	Description
`name`	String	検索対象サービス

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

size(size) → {ContentsSearchRequest}

検索結果の取得件数を設定する

Parameters:

Name	Type	Description
`size`	Number	コンテンツ検索結果の取得件数

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

sort(name, order) → {ContentsSearchRequest}

ソート条件を設定する

Parameters:

Name	Type	Argument	Default	Description
`name`	String			ソート条件となるフィールド
`order`	String	<optional>	desc	asc/desc (昇順/降順)

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest

target(names) → {ContentsSearchRequest}

検索対象となるフィールドを設定する

Parameters:

Name	Type	Description
`names`	Array	検索対象フィールドリスト

Source:

search-nico.js

Returns:

コンテンツ検索リクエストインスタンス

Type: ContentsSearchRequest