EksiMember

EksiMember

Eksi Sozluk member class.

Constructor

new EksiMember(httpClient, cookies)

Create an Eksi Sozluk member session.

Source:
Parameters:
Name Type Description
httpClient object

Axios HTTP client.
cookies string

Cookies in string.

Extends

Members

isNewEventAvailable :boolean

Is new event available?

Source:
Type:
  • boolean

isNewMessageAvailable :boolean

Is new message available?

Source:
Type:
  • boolean

username :string

Username.

Source:
Type:
  • string

Methods

(async) agenda(options) → {Promise.<TitleCollection>}

Fetch agenda.

Overrides:
Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the agenda titles.

cancelEmailAddressChange() → {Promise.<boolean>}

Cancel the email address change.

Source:
Returns:
Type:
Promise.<boolean>

A promise for cancel the email address change.

changeEmailAddress(currEmailAddress, newEmailAddress, password) → {Promise}

Change your email address.

Source:
Parameters:
Name Type Description
currEmailAddress string

Your current email address.
newEmailAddress string

A new email address.
password string

Your current password.
Returns:
Type:
Promise

A promise for change email address.

changeLoginUsername(newUsername, password) → {Promise}

Change login username.

Source:
Parameters:
Name Type Description
newUsername string

Your new login username.
password string

Your current password.
Returns:
Type:
Promise

Promise.

changePassword(currPassword, newPassword) → {Promise.<boolean>}

Change your password.

Source:
Parameters:
Name Type Description
currPassword string

Your current password.
newPassword string

A new password.
Returns:
Type:
Promise.<boolean>

A promise for change password.

createBackup() → {Promise}

Create backup.

Source:
Returns:
Type:
Promise

A promise for create backup.

(async) createEntry(title, content, options) → {Promise.<(EntryForMember|DraftEntry)>}

Create entry.

Source:
Parameters:
Name Type Description
title string

Title.
content string

Entry content.
options object

Parameters that user can specify.

Name Type Attributes Default Description
saveAsDraft boolean <optional>
 false

Save as draft.
Returns:
Type:
Promise.<(EntryForMember|DraftEntry)>

Created entry.

(async) debeEntries() → {Promise.Array.<EntryForMember>}

Fetch yesterday's top entries.

Overrides:
Source:
Returns:
Type:
Promise.Array.<EntryForMember>

A promise for the yesterday's top entries.

deleteAccount(password, hideEntriesopt) → {Promise}

Delete your account.

Source:
Parameters:
Name Type Attributes Default Description
password string

Your current password.
hideEntries boolean <optional>
 false

Hide your entries.
Returns:
Type:
Promise

Promise.

deleteImage(imageKey) → {Promise}

Remove image with given image key.

Source:
Parameters:
Name Type Description
imageKey string

Image key.
Returns:
Type:
Promise

Promise.

(async) drafts(options) → {Promise.<TitleCollection>}

Fetch draft entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the titles of drafts.

emptyTrash() → {Promise}

Empty trash.

Source:
Returns:
Type:
Promise

Promise.

(async) entries(title, options) → {Promise.<EntryCollection>}

Fetch entries.

Overrides:
Source:
Parameters:
Name Type Description
title string

Title itself.
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<EntryCollection>

A promise for the entries.

(async) entryById(entryId) → {Promise.<EntryForMember>}

Fetch entry by id.

Overrides:
Source:
Parameters:
Name Type Description
entryId number

Entry Id.
Returns:
Type:
Promise.<EntryForMember>

A promise for the entry.

(async) events() → {Promise.<TitleCollection>}

Fetch events.

Source:
Returns:
Type:
Promise.<TitleCollection>

A promise for the titles of events.

(async) followedUserFavoriteEntries(options) → {Promise.<TitleCollection>}

Fetch followed user favorite entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the followed user titles.

(async) followedUserTitles(options) → {Promise.<TitleCollection>}

Fetch followed user titles.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the followed user titles.

isEmailAddressInChangeStatus() → {Promise.<boolean>}

Checking if your email address is in change status.

Source:
Returns:
Type:
Promise.<boolean>

Email address waiting for changing or not.

isNewEventExist() → {Promise.<boolean>}

Check if unread event exist.

Source:
Returns:
Type:
Promise.<boolean>

New event available or not.

isNewMessageExist() → {Promise.<boolean>}

Check if unread message exist.

Source:
Returns:
Type:
Promise.<boolean>

New message available or not.

(async) me() → {Promise.<UserForMember>}

Fetch the user profile.

Source:
Returns:
Type:
Promise.<UserForMember>

A promise for the entry.

pinEntry(entryId) → {Promise}

Pin an entry to the profile.

Source:
Parameters:
Name Type Description
entryId number

Entry ID which user owns.
Returns:
Type:
Promise

Promise.

(async) questionsInAgenda(options) → {Promise.<TitleCollection>}

Fetch questions in agenda.

Overrides:
Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the agenda titles in agenda.

(async) questionsInToday(options) → {Promise.<TitleCollection>}

Fetch questions in today.

Overrides:
Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the agenda titles in today.

removePin() → {Promise}

Remove pin from profile.

Source:
Returns:
Type:
Promise

Promise.

retrieve() → {Promise}

Retrieve the user.

Source:
Returns:
Type:
Promise

Promise.

(async) rookieTitles(options) → {Promise.<TitleCollection>}

Fetch rookie entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the rookie titles.

Search things.

Overrides:
Source:
Parameters:
Name Type Description
text string

Search text.
Returns:
Type:
Promise.<SearchResults>

A promise for the search results.

(async) tags() → {Promise.Array.<TagForMember>}

Fetch tags.

Overrides:
Source:
Returns:
Type:
Promise.Array.<TagForMember>

A promise for the tags.

(async) titlesByTag(tagName, options) → {Promise.<TitleCollection>}

Fetch titles by tag.

Overrides:
Source:
Parameters:
Name Type Description
tagName TagName

Tag name.
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the titles of given tag.

(async) today(options) → {Promise.<TitleCollection>}

Fetch today entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the titles of today.

(async) todayInHistory(year, options) → {Promise.<TitleCollection>}

Fetch today in history.

Overrides:
Source:
Parameters:
Name Type Description
year string

Which year.
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for the titles of today in history.

(async) trashEntries(options) → {Promise.Array.<TrashEntry>}

Fetch trash entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.Array.<TrashEntry>

A promise for the trash entries.

(async) untaggedTitles(options) → {Promise.<TitleCollection>}

Fetch untagged titles.

Overrides:
Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
Returns:
Type:
Promise.<TitleCollection>

A promise for untagged titles.

uploadImage(imagePath) → {Promise.<UploadedImage>}

Upload image.

Source:
Parameters:
Name Type Description
imagePath string

Image file path.
Returns:
Type:
Promise.<UploadedImage>

Promise.

(async) user(username) → {Promise.<UserForMember>}

Fetch user.

Overrides:
Source:
Parameters:
Name Type Description
username string

Entry Id.
Returns:
Type:
Promise.<UserForMember>

A promise for the entry.