@fnlb-project/fnbr
Version:
A library to interact with Epic Games' Fortnite HTTP and XMPP services
85 lines (84 loc) • 2.23 kB
TypeScript
import Base from '../../Base';
import type Client from '../../Client';
import type Friend from './Friend';
import type { FriendPresenceData, PresenceGameplayStats, Platform, PresenceOnlineType } from '../../../resources/structs';
/**
* Represents a friend's presence
*/
declare class FriendPresence extends Base {
/**
* The friend this presence belongs to
*/
friend: Friend;
/**
* The status of the friend (eg. "Battle Royale Lobby - 1 / 16")
*/
status?: string;
/**
* The date when this presence was recieved
*/
receivedAt: Date;
/**
* Whether the friend is playing
*/
isPlaying?: boolean;
/**
* Whether the friend's party is joinable
*/
isJoinable?: boolean;
/**
* Whether the friend has voice support
*/
hasVoiceSupport?: boolean;
/**
* The id of the game session the friend is currently in
*/
sessionId?: string;
/**
* The rating of the friend's SaveTheWorld homebase
*/
homebaseRating?: number;
/**
* The subgame the friend is in
*/
subGame?: number;
/**
* Whether the friend is in an unjoinable match or not
*/
isInUnjoinableMatch?: boolean;
/**
* The friend's current selected playlist
*/
playlist?: string;
/**
* The member count of the friend's party
*/
partySize?: number;
/**
* The max members of the friend's party
*/
partyMaxSize?: number;
/**
* The join key of the game session the friend is currently in (if the game session is joinable)
*/
gameSessionJoinKey?: string;
/**
* The stats of the game the friend is currently in
*/
gameplayStats?: PresenceGameplayStats;
/**
* The platform the friend is currently playing on
*/
platform?: Platform;
/**
* The friend's online type
*/
onlineType: PresenceOnlineType;
/**
* @param client The main client
* @param data The presence data
* @param friend The friend this presence belongs to
*/
constructor(client: Client, data: FriendPresenceData, friend: Friend, show: PresenceOnlineType, from: string);
}
export default FriendPresence;