Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FanGroup

Hierarchy

Index

Properties

accessMode

accessMode: FG_ACCESS_MODE

FanGroup's access mode

backgroundImageUrl

backgroundImageUrl: string

FanGroup's profile image

billingParameters

billingParameters: FanGroupBillingParameters

categories

categories: object

clientId

clientId: string

color1

color1: string

FanGroup's color 1

color2

color2: string

FanGroup's color 2

coverImageUrl

coverImageUrl: string

FanGroup's cover image

createdDate

createdDate: string

description

description: object

fanGroupId

fanGroupId: string

fanMember

fanMember: boolean

True if authenticated fan is member of the FanGroup

geoFilteringNotificationDescription

geoFilteringNotificationDescription: any

To use as description when notification about geo location is needed

geoFilteringNotificationTitle

geoFilteringNotificationTitle: any

To use as title when notification about geo location is needed

groupCategories

groupCategories: FanGroupCategory[]

Fan Group categories

id

id: string

FanGroup's ID

format

UUID

lastModifiedDate

lastModifiedDate: string

logoImageUrl

logoImageUrl: string

membership

membership: Membership

A description of the membership of the Fan to the Fan Group

name

name: object

FanGroup's name: {string=>string}

deprecated

use translatedName

operationParameters

operationParameters: FanGroupOperationParameters

privacyPolicy

privacyPolicy: TranslatedText

Privacy Policy links {string=>string} - 1 per supported locale

profileImageUrl

profileImageUrl: string

FanGroup's profile image

protectionCodeExplanation

protectionCodeExplanation: TranslatedText

How to get the protection code, translated in user locale

rankAndLikelihoodHidden

rankAndLikelihoodHidden: boolean

Visibility of rank & likelihood indicator

shortName

shortName: TranslatedText

FanGroup's short name: {string=>string}

deprecated

use translatedShortName

showLogo

showLogo: boolean

Visibility of logo indicator

slug

slug: string

FanGroup's slug

statistics

statistics: object

FanGroup statistics

status

termsAndConditions

termsAndConditions: TranslatedText

Terms and condition links {string=>string} - 1 per supported locale

themeId

themeId: string

translatedName

translatedName: string

Fan Group's name, translated in fan locale

translatedShortName

translatedShortName: string

Fan Group's short name, translated in fan locale

translatedWelcomeText

translatedWelcomeText: string

Fan Group's welcome text, translated in fan locale

type

type: "FAN_GROUP"

visibility

visibility: VISIBILITY

FanGroup's visibility

welcomeText

welcomeText: TranslatedText

FanGroup's welcome text: {string=>string}

deprecated

use translatedWelcomeText

Generated using TypeDoc