-
Notifications
You must be signed in to change notification settings - Fork 34
Client
const { Client } = require('epicgames-client');
let client = new Client({
email: '',
password: '',
debug: null, // if you need console/file output with logs. Simple you can use `console.log`
useWaitingRoom: true, // false to ignore waiting room (epicgames load balancer)
http: {
// settings for lib https://github.com/request/request
}
});
- build - Desktop's launcher version
- UEBuild - Unreal Engine version
-
appName - Application name, everytime
Launcher
. -
account - logged account's object
- id
- displayName
- firstName
- lastName
- ageGroup
- country
- preferredLanguage
- lastLogin
- failedLoginAttempts
Initialize client
Login to an account.
Kill account's session on epicgames servers.
Checks if
value
is account's id.
- value {string}
Checks if
value
is account's display name.
- value {string}
Returns array of domains using by EpicGames.
Returns game object or
false
if can't run game.
- game {object} - game library, e.g. epicgames-fortnite-client
- options {object} (optional) - game library constructor options
-
iso_lang_code {string} - e.g.
en
,en-US
,pl
,pl-PL
Returns
User
object orfalse
if user not found.
- id_or_name {string} - user's display name or id
Returns array of
User
objects.
- arr {array} - Array with names or ids (can be mixed)
Returns account's id, display name and extarnalAuths or
false
if user not found. I recommend usegetProfile
method.
- display_name {string} - user's display name
Returns array of your friends (
Friend
objects).
- include_pending {boolean} (optional) - whether including pending friends (invite requests).
Returns array of your pending friends.
Verifying given account is your friend.
- id_or_name {string} - user's display name or id
Returns array of your blacklisted friends.
Blocking a friend. Returns
Friend
orfalse
depending on whether the operation was successful.
- id_or_name {string} - user's display name or id
Removing a friend. Returns
Friend
orfalse
depending on whether the operation was successful.
- id_or_name {string} - user's display name or id
Sending a friend invite request. Returns
Friend
orfalse
depending on whether the operation was successful.
- id_or_name {string} - user's display name or id
Accepting friend's invitation. Alias for method inviteFriend
- id_or_name {string} - user's display name or id
Declining friend's invitation. Alias for method removeFriend
- id_or_name {string} - user's display name or id
Returns object with informations about the current client (build etc.).
Returns "DEPRECATED" or "NOT_DEPRECATED"