JSDoc: Class: EksiClient

Constructor

new EksiClient(options, version)

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`uri`	String	api urlesi
`client_secret`	String	api client_secret id'si

version string api servisi sürümü

Author:

c0b41

Copyright:

c0b41 2018 MIT

Source:

index.js, line 10

Methods

define(env) → {Void}

Api servisine istek atabilmek için kullanıcı verileri set etmeye yarıyor

Parameters:

Name Type Description

env

Object

Properties

Name	Type	Description
`access_token`	String
`nick`	String
`user_id`	Number

Source:

index.js, line 35

Returns:

Type: Void

(async) getAccessToken(params) → {Promise}

Api servisi üzerinden access token almak için kullanılıyor

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`username`	String
`password`	String

Source:

index.js, line 54

Returns:

Type: Promise

(async) getAutoCompletes(query) → {Promise}

Parameters:

Name	Type	Description
`query`	String	Aranan kelime

Source:

index.js, line 541

Returns:

Type: Promise

(async) getChannel(name, params) → {Promise}

Ekşi sözlük Kanallarına ait konuları getirmek için

Parameters:

Name Type Description

name String Kanal Adı

params

Object

Properties

Name	Type	Description
`p`	Object	Sayfa sayısı

Source:

index.js, line 528

Returns:

Type: Promise

(async) getChannels(params) → {Promise}

Ekşi sözlük kanalları

Parameters:

Name	Type	Description
`params`	Object	##

Source:

index.js, line 514

Returns:

Type: Promise

(async) getEntry(params) → {Promise}

Entry'e erişmek için

Parameters:

Name	Type	Description
`params`	Object

Source:

index.js, line 98

Returns:

Type: Promise

(async) getEvents(params) → {Promise}

Takip ettiğiniz konuların listesi için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 379

Returns:

Type: Promise

(async) getMe(params) → {Promise}

Kendi kullanıcınıza ait verilere ulaşmak için

Parameters:

Name	Type	Description
`params`	Object

Source:

index.js, line 77

Returns:

Type: Promise

(async) getMessage(nick, params) → {Promise}

Mesajı getirmek için

Parameters:

Name Type Description

nick String Kullanıcı adı

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 393

Returns:

Type: Promise

(async) getMessages(params) → {Promise}

Kendinize ait mesajlara erişmek için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 368

Returns:

Type: Promise

(async) getMyBuddysFavorites(params) → {Promise}

Takip ettiğiniz yazarların favorilediği entryler

Parameters:

Name	Type	Description
`params`	Object	##

Source:

index.js, line 501

Returns:

Type: Promise

(async) getMyBuddysTopics(params) → {Promise}

Takip ettiğiniz yazarların entry girdiği konular

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 489

Returns:

Type: Promise

(async) getMyEntrys(params) → {Promise}

Kendinize ait entryleri erişmek için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 111

Returns:

Type: Promise

(async) getMyFavorites(params) → {Promise}

Kendinize ait favorileri erişmek için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 125

Returns:

Type: Promise

(async) getMyUnreadMessagesCount(params) → {Promise}

Kendinize ait okunmamış mesaj sayısı

Parameters:

Name	Type	Description
`params`	Object

Source:

index.js, line 406

Returns:

Type: Promise

(async) getMyUnreadTopicsCount(params) → {Promise}

Takip edilen okunmamış konular'a ait okunmamış konu sayısı

Parameters:

Name	Type	Description
`params`	Object

Source:

index.js, line 419

Returns:

Type: Promise

(async) getPopularTopics(params) → {Promise}

Bugün girilen popüler konular

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 476

Returns:

Type: Promise

(async) getTodayTopics(params) → {Promise}

Bugün girilen konular

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 463

Returns:

Type: Promise

(async) getTopicEntrys(params) → {Promise}

Konuya girilen entrylere erişmek için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı
`day`	String	Tarih

Source:

index.js, line 450

To Do:

not working

Returns:

Type: Promise

(async) getTopicEntrysToday(params) → {Promise}

Konuya bugün girilen entrylere erişmek için

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 434

To Do:

not working

Returns:

Type: Promise

(async) getUser(nick, params) → {Promise}

Başka bir kullanıcıya ait verilere ulaşmak için

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 139

Returns:

Type: Promise

(async) getUserEntrys(nick, params) → {Promise}

Başka bir kullanıcıya ait entryleri erişmek için

Parameters:

Name Type Description

nick String Kullanıcı adı

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 339

Returns:

Type: Promise

(async) getUserFavorites(nick, params) → {Promise}

Başka bir kullanıcıya ait favorileri erişmek için

Parameters:

Name Type Description

nick String Kullanıcı adı

params

Object

Properties

Name	Type	Description
`p`	Number	Sayfa sayısı

Source:

index.js, line 354

Returns:

Type: Promise

(async) setEntryDownvote(entry_id, params) → {Promise}

Entry Downvote

Parameters:

Name	Type	Description
`entry_id`	Number	Entry id
`params`	Object

Source:

index.js, line 200

Returns:

Type: Promise

(async) setEntryFavorite(entry_id, params) → {Promise}

Entry Favorite

Parameters:

Name	Type	Description
`entry_id`	Number	Entry id
`params`	Object

Source:

index.js, line 216

Returns:

Type: Promise

(async) setEntryUnfavorite(entry_id, params) → {Promise}

Entry Unfavorite

Parameters:

Name	Type	Description
`entry_id`	Number	Entry id
`params`	Object

Source:

index.js, line 232

Returns:

Type: Promise

(async) setEntryUpvote(entry_id, params) → {Promise}

Entry Upvote

Parameters:

Name	Type	Description
`entry_id`	Number	Entry id
`params`	Object

Source:

index.js, line 184

Returns:

Type: Promise

(async) setRefreshAccessToken()

Ekşi sözlük apisinde tokeninizi yenilemek için henüz bir route yok tokeninizi yenilemek isterseniz @getAccessToken methodunu kullanmanız gerek

Source:

index.js, line 89

To Do:

not working.

(async) setSearch(params) → {Promise}

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`term`	String	Aranan kelime

Source:

index.js, line 555

To Do:

not working

Returns:

Type: Promise

(async) setTopicFollow(topic_id, params) → {Promise}

Konu takip et

Parameters:

Name	Type	Description
`topic_id`	Number	Konu id
`params`	Object

Source:

index.js, line 152

Returns:

Type: Promise

(async) setTopicUnfollow(topic_id, params) → {Promise}

Konu takibi bırakma

Parameters:

Name	Type	Description
`topic_id`	Number	Konu id
`params`	Object

Source:

index.js, line 168

Returns:

Type: Promise

(async) setUserBlock(nick, params) → {Promise}

Kullanıcı engelleme

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 248

Returns:

Type: Promise

(async) setUserFollow(nick, params) → {Promise}

Kullanıcı takip et

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 309

Returns:

Type: Promise

(async) setUserTopicsBlock(nick, params) → {Promise}

Kullanıcı konularını engelleme

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 277

Returns:

Type: Promise

(async) setUserTopicsUnblock(nick, params) → {Promise}

Kullanıcı konularını engeli kaldırma

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 293

Returns:

Type: Promise

(async) setUserUnblock(nick, params) → {Promise}

Kullanıcı engelli kaldırma

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 261

Returns:

Type: Promise

(async) setUserUnfollow(nick, params) → {Promise}

Kullanıcı takipden çıkar

Parameters:

Name	Type	Description
`nick`	String	Kullanıcı Adı
`params`	Object

Source:

index.js, line 322

Returns:

Type: Promise