@leaddreamer/esbrowser v0.1.0-beta.0
@SaltSweetSpirits/ESBrowser
Browser functions for the Event Services system, wrapped around ESBusiness and indirectly firebase-wrapper, for the Front End.
Modules
Functions
ESBrowser
Browser functions for the Event Services system, wrapped around ESBusiness and indirectly firebase-wrapper, for the Front End.
- ESBrowser
- static
- .startBrowser(firebase, config) ⇒ Promise
- inner
- ~FirebaseConfigObject : object
- static
ESBrowser.startBrowser(firebase, config) ⇒ Promise
starts the database and redux systems in the browser the client-specific firebase instance must be passed the client-specific config object must be passes Starts the database, and initiates the user authentication system
Kind: static method of ESBrowser
Param | Type |
---|---|
firebase | FirebaseInstance |
config | FirebaseConfigObject |
ESBrowser~FirebaseConfigObject : object
only authDomain, databaseURL and storageBucket are present when called from a cloud environment
Kind: inner typedef of ESBrowser
Properties
Name | Type | Description |
---|---|---|
apiKey | string | required api Key from Firebase Console, |
appId | string | required app ID from Firebase Console |
projectId | string | required Firebase projectID from Firebase console |
authDomain | string | (optional) auth domain from Firebase Console |
databaseURL | string | (optional) Firestore database URL from Firebase console |
storageBucket: | string | (optional) URL of Firestore Storage Bucket |
messagingSenderId: | string | (optional) ID for Messaing service from Firebase Console |
measurementId: | string | (optional) Analytics/Measurement ID from Firebase Console |
mapsAPIKey | string | (optional) App ID for Google Maps API, from Google |
Browser
Browser-specific Event Services business logic and database operations
CityManager
CityManager browser support operations
- CityManager
- static
- .subscribeCityManager ⇒ string
- .createCityManagerAccount(cityManagerForm) ⇒ Promise.Credential
- .loginCityManager(cityManager_roles) ⇒ Promise.Credential
- .logoutCityManager() ⇒ Promise.Credential
- .makeActiveCityManager(cityManager_role) ⇒ Promise.<null>
- .retireActiveCityManager() ⇒ ActionItem
- .listenCityManager(uid) ⇒ callback
- inner
- ~disableCityManager() ⇒ null
- static
CityManager.subscribeCityManager ⇒ string
Sets up CityManager listeners and populates City Manager role in Redux Surprisingly, entirely synchronous with async side effects
Kind: static constant of CityManager
Returns: string - key to listener store for cityManager listener
Param | Type |
---|---|
cityManagerID | string |
CityManager.createCityManagerAccount(cityManagerForm) ⇒ Promise.Credential
Makes a call to the backend to have an artist account created. (security requires this to be done ina secure environment)
Kind: static method of CityManager
Param | Type |
---|---|
cityManagerForm | CityManagerType |
CityManager.loginCityManager(cityManager_roles) ⇒ Promise.Credential
Kind: static method of CityManager
Param | Type |
---|---|
cityManager_roles | object |
CityManager.logoutCityManager() ⇒ Promise.Credential
Disables the local (client) CityManager, and removes the CityManager credential. All other logout activity is async
Kind: static method of CityManager
CityManager.makeActiveCityManager(cityManager_role) ⇒ Promise.<null>
accepts the selected "cityManager_role" and uses it to login & setup control of the indicated CityManager account.
Kind: static method of CityManager
Param | Type | Description |
---|---|---|
cityManager_role | cityManager_role | { Id: {string} cityManagerID name: {string} cityManager_name role: {string} management role } |
CityManager.retireActiveCityManager() ⇒ ActionItem
Runs all unsubscribes and disables cityManager settings in Redux store. Entirely Synchronous (with possible async side effects)
Kind: static method of CityManager
CityManager.listenCityManager(uid) ⇒ callback
Sets up a listener specifically to the Redux store; returns the unsubscribe function will be called AT LEAST ONCE with initial document
Kind: static method of CityManager
Returns: callback - an unsubscribe function
Param | Type | Description |
---|---|---|
uid | string | UID of the CITYMANAGER record for the Redux store to listen too. |
CityManager~disableCityManager() ⇒ null
disables the active CityManager in the client (no credential change)
Kind: inner method of CityManager
CloudCustomerPayment
Customer payment account cloud functions
- CloudCustomerPayment
- static
- .capturePaymentMethod(personId) ⇒ Promise.secret_object
- .setFanCard(personId, PDSummary) ⇒ Promise.<void>
- .deleteFanCard(personId, PDSummary) ⇒ Promise.<void>
- inner
- ~secret_object : object
- static
CloudCustomerPayment.capturePaymentMethod(personId) ⇒ Promise.secret_object
Prepares to capture a payment method for a user
Kind: static method of CloudCustomerPayment
Returns: Promise.secret_object - - client secret
Param | Type | Description |
---|---|---|
personId | string | Id of person account to create customer payment account for |
CloudCustomerPayment.setFanCard(personId, PDSummary) ⇒ Promise.<void>
Securely sets the particular paymentMethod as active
Kind: static method of CloudCustomerPayment
Param | Type | Description |
---|---|---|
personId | string | Id of person owning this payment |
PDSummary | PDSummary | paymentDescriptor |
CloudCustomerPayment.deleteFanCard(personId, PDSummary) ⇒ Promise.<void>
Kind: static method of CloudCustomerPayment
Param | Type | Description |
---|---|---|
personId | string | a user Id |
PDSummary | PDSummary | paymentDescriptor of method to delete |
CloudCustomerPayment~secret_object : object
Payment System "secret" for secure front-end
Kind: inner typedef of CloudCustomerPayment
Properties
Name | Type |
---|---|
payment_secret | string |
CloudEvents
Event support Cloud Functions
- CloudEvents
- .httpsOnCallCreateLocalEvent(event, ticketPrice, tickets) ⇒ Promise.<void>
- .confirmEvent(eventId) ⇒ Promise.<void>
- .fixEventSummary(eventId) ⇒ Promise.<void>
- .cancelEvent(eventId) ⇒ Promise.<void>
CloudEvents.httpsOnCallCreateLocalEvent(event, ticketPrice, tickets) ⇒ Promise.<void>
Creates an event from scratch by an organization
Kind: static method of CloudEvents
Param | Type | Description |
---|---|---|
event | EventType | |
event.owner | OrganizationType | |
event.owner.Id | string | Id of venue creating event |
event.owner.name | string | name of venue creating the event |
event.owner.capacity | number | string | capacity of organization creating event |
data.counterID | string | Id of artist/act for event being created |
data.showDate | dateString | date/time of event being created |
ticketPrice | number | string | ticket price for event being created |
tickets | number | string | number of pre-sold tickets for event being created |
CloudEvents.confirmEvent(eventId) ⇒ Promise.<void>
This function verifies credentials (cityManager of correct region for event), calculates the correct artist/venue shares, then initiates the required transfers to accounts connected to artist/venue. Receipts (on success) will be attached to artist/venue by webhook. Note security checks are at SERVER/CLOUD FUNCTION. Note this function STARTS the process (marks the event) - the BACKEND executes the operation asynchronously to not delay FRONTEND
Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.
Param | Type | Description |
---|---|---|
eventId | string | Id of the event to approve for payout |
CloudEvents.fixEventSummary(eventId) ⇒ Promise.<void>
This function re-calculates the summary (from pledgeTickets) for a event.
Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.
Param | Type | Description |
---|---|---|
eventId | string | Id of the event to re-calculate the summary data. |
CloudEvents.cancelEvent(eventId) ⇒ Promise.<void>
This function verifies credentials (cityManager of correct region for event), marks each pledgeTicket and corresponding receipt as REFUNDING then issues a refund through the payment system on all charges. Note security checks are at SERVER/CLOUD FUNCTION Note this function STARTS the process (marks the event) - the BACKEND executes the operation asynchronously to not delay FRONTEND
Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.
Param | Type | Description |
---|---|---|
eventId | string | Id of the event to approve for paytout |
CloudFunctions
Project specific Cloud functions
- CloudFunctions
- static
- .httpsOnCallSlipDates ⇒ Promise.boolean
- .requestCancelPledge ⇒ Promise
- .authClaims(user) ⇒ Promise.Credential
- .changeCredential(credential) ⇒ Promise.<void>
- .httpsOnCallCredentials(credential) ⇒ Promise
- .httpsOnCallOfferAccess(offer) ⇒ Promise
- .httpsOnCallCheckIn(checkin) ⇒ Promise
- .fixPledgeTicket(pledgeTicket) ⇒ Promise.secret_object
- inner
- ~Credential : object
- static
CloudFunctions.httpsOnCallSlipDates ⇒ Promise.boolean
Admin/Test function to push all dated object "shiftDays" forward
Kind: static constant of CloudFunctions
Param | Type |
---|---|
shiftDays | number |
CloudFunctions.requestCancelPledge ⇒ Promise
Request to cancel a pledgeTicket (needs payment check)
Kind: static constant of CloudFunctions
Param | Type |
---|---|
pledgeTicket | pledgeTicketObject |
CloudFunctions.authClaims(user) ⇒ Promise.Credential
fetches our specific custom claim values from user Token
Kind: static method of CloudFunctions
Param | Type | Description |
---|---|---|
user | UserObject | firebase auth user object |
CloudFunctions.changeCredential(credential) ⇒ Promise.<void>
use a "credential" object to add a new server-side role to a user
Kind: static method of CloudFunctions
Param | Type | Description |
---|---|---|
credential | Credential | the new credential being requested. Verified and set at server-side |
CloudFunctions.httpsOnCallCredentials(credential) ⇒ Promise
Cloud function to set credentials object
Kind: static method of CloudFunctions
Param | Type |
---|---|
credential | Credential |
CloudFunctions.httpsOnCallOfferAccess(offer) ⇒ Promise
Cloud function for organizatin to offer user access control
Kind: static method of CloudFunctions
Param | Type |
---|---|
offer | AccessOffer |
CloudFunctions.httpsOnCallCheckIn(checkin) ⇒ Promise
Cloud function to allow Organization to CheckIn a user/ticket to an event
Kind: static method of CloudFunctions
Param | Type |
---|---|
checkin | checkInObject |
CloudFunctions.fixPledgeTicket(pledgeTicket) ⇒ Promise.secret_object
"Fix" a pledgeTicket - ie setup to take new payment
Kind: static method of CloudFunctions
Param | Type |
---|---|
pledgeTicket | pledgeTicketObject |
CloudFunctions~Credential : object
Kind: inner typedef of CloudFunctions
Properties
Name | Type | Description |
---|---|---|
artist | string | Artists's Id |
venue | string | venue Id |
adminStatus | boolean | |
superUser | boolean | |
employee | boolean |
CloudPaymentProcessing
Cloud Functions to secure manage paymentProcessing accounts
- CloudPaymentProcessing
- static
- .accountStatus ⇒ Promise.AccountStatus
- .httpsOnCallCreateAccounts(data) ⇒ Promise.PaymentAccount
- .onboardAccount(accountObject) ⇒ Promise.AccountStatus
- inner
- ~AccountRequestData : object
- static
CloudPaymentProcessing.accountStatus ⇒ Promise.AccountStatus
Cloud function to check PaymentProcessor account status
Kind: static constant of CloudPaymentProcessing
Param | Type | Description |
---|---|---|
accountId | string | PaymentProcessor account ID (unique) |
CloudPaymentProcessing.httpsOnCallCreateAccounts(data) ⇒ Promise.PaymentAccount
Securely creates an oganization paymentProcessing account
Kind: static method of CloudPaymentProcessing
Param | Type |
---|---|
data | AccountRequestData |
CloudPaymentProcessing.onboardAccount(accountObject) ⇒ Promise.AccountStatus
Cloud function to onboard a paymentProcessor account
Kind: static method of CloudPaymentProcessing
Param | Type |
---|---|
accountObject | PaymentAccount |
CloudPaymentProcessing~AccountRequestData : object
Kind: inner typedef of CloudPaymentProcessing
Properties
Name | Type | Description |
---|---|---|
type | string | either "Artists" or "Venues" |
account | ArtistFormType | VenueType |
EventGroups
Business and Database support functions for the Browser
EventGroups.listenEventGroups(organization, dataCallBack, errCallBack) ⇒ callback
Sets up a listener for all the EventGroups for a particular Organization
Kind: static method of EventGroups
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganiztionType |
dataCallBack | callback |
errCallBack | callback |
Events
- Events
- .ListenEvents(eventgroup, dataCallBack, errCallBack) ⇒ callback
- .ListenListing(organization, dataCallback, errCallback, startDate) ⇒ callback
- .ListenOrganizationEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
- .ListenOrganizationCounterEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
- .ListenOrganizationShows(organization, dataCallback, errCallback) ⇒ callback
- .ListenOrganizationCounterShows(organization, dataCallback, errCallback) ⇒ callback
Events.ListenEvents(eventgroup, dataCallBack, errCallBack) ⇒ callback
Sets up a listener for all the Events for a particular EventGroup
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
eventgroup | EventGroupType |
dataCallBack | callback |
errCallBack | callback |
Events.ListenListing(organization, dataCallback, errCallback, startDate) ⇒ callback
Listener for Organization Owner shows (after a certain date)
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganizationType |
dataCallback | callback |
errCallback | callback |
startDate | dateString |
Events.ListenOrganizationEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
Listener for Organization Owner shows (after a certain date)
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganizationType |
dataCallback | callback |
errCallback | callback |
startDate | dateString |
Events.ListenOrganizationCounterEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
Listener for Organization Counter events (after a certain date)
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganizationType |
dataCallback | callback |
errCallback | callback |
startDate | dateString |
Events.ListenOrganizationShows(organization, dataCallback, errCallback) ⇒ callback
Listener for Organization Owner shows (booked events)
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganizationType |
dataCallback | callback |
errCallback | callback |
Events.ListenOrganizationCounterShows(organization, dataCallback, errCallback) ⇒ callback
Listener for Organization counter shows (booked events)
Kind: static method of Events
Returns: callback - unsubscribe function
Param | Type |
---|---|
organization | OrganizationType |
dataCallback | callback |
errCallback | callback |
Favorites
Intended for managing Fan favorites. Unfinished
Favorites.favoritesMapMaker(favoriteRecords) ⇒ Map
transforms array into keyed Map()
Kind: static method of Favorites
Param | Type |
---|---|
favoriteRecords | Array.FavoriteRecord |
Fundamentals
- Fundamentals
- .ListenFundamentals() ⇒ callback
- .ListenMCCs() ⇒ function
Fundamentals.ListenFundamentals() ⇒ callback
A function that returns a function to attach as a listener, that returns a function to unsubscribe
Kind: static method of Fundamentals
Fundamentals.ListenMCCs() ⇒ function
A function that returns a function to attach as a listener, that returns a function to unsubscribe A function that "pretends" to be a listener, to maintain consistent structure Only loads at boot-up
Kind: static method of Fundamentals
Genres
Database handling functions for Genres
- Genres
- static
- .fetchGenres() ⇒ Array.GenreObject
- .fetchGenre(genreID) ⇒ GenreObject
- .fetchFormattedGenre(genreID) ⇒ GenreObject
- inner
- ~ListenGenres() ⇒ callback
- static
Genres.fetchGenres() ⇒ Array.GenreObject
Kind: static method of Genres
Genres.fetchGenre(genreID) ⇒ GenreObject
Fetch a single GenreObject from the store by Id
Kind: static method of Genres
Param | Type |
---|---|
genreID | string |
Genres.fetchFormattedGenre(genreID) ⇒ GenreObject
Fetch a single GenreObject from the store by Id and returns as formatted string
Kind: static method of Genres
Param | Type |
---|---|
genreID | string |
Genres~ListenGenres() ⇒ callback
Kind: inner method of Genres
Returns: callback - unsubscribe function
Images
basic Redux/Database functions for images
- Images
- .setDefaultImage() ⇒ callback
- .setDefaultBanner() ⇒ callback
- .setDefaultLoading() ⇒ callback
- .pullURLFromRecord(record, key) ⇒ Promise.string
- .accessibleStorage(URL) ⇒ Promise.<URL>
Images.setDefaultImage() ⇒ callback
Fires off an async closure to get and set image. Could be thunk?
Kind: static method of Images
Images.setDefaultBanner() ⇒ callback
Fires off an async closure to get and set image. Could be thunk?
Kind: static method of Images
Images.setDefaultLoading() ⇒ callback
Fires off an async closure to get and set loading. Could be thunk?
Kind: static method of Images
Images.pullURLFromRecord(record, key) ⇒ Promise.string
This Utility checks if a full URL needs to be built. Image data can be => a tokenized URL, by definition public => a "private", secured URL => a filename, assumed to be stored in a structure parallel to the record path
Kind: static method of Images
Fulfil: string a "private" URL to access the file.
Reject: string
Param | Type | Description |
---|---|---|
record | RecordObject | A firestore document Record - the '/' separated collection/ document path is used as the path to the stored item. |
key | string | An optional string identifying the specific field an stored item is associated with |
Images.accessibleStorage(URL) ⇒ Promise.<URL>
This Utility checks if URL is Secured by Storage Security Rules If the URL carries an access token, it is simply returned. If the URL does NOT have an access token, it is fetched to local stoage with authentication, and a new URL created to point to the local copy.
Kind: static method of Images
Fulfil: string a local URL to access the downloaded data
Reject: string
Param | Type |
---|---|
URL | string |
Organizations
Browser-specific Business logic and database operations
- Organizations
- .createOrganizationAccount(organizationForm) ⇒ Promise
- .loginOrganization(organization_role) ⇒ Promise
- .logoutOrganization() ⇒ Promise
- .makeActiveOrganization(organization_role) ⇒ Promise.<void>
- .retireActiveOrganization() ⇒ void
- .subscribeOrganization(organizationID) ⇒ string
- .listenOrganization(uid) ⇒ callback
- .disableOrganization() ⇒ void
- .listenOrganizations(dataCallback, errCallback) ⇒ callback
- .listenOrganizationsPaginated(dataCallback, errCallback, pageSize, optional) ⇒ PaginatedListener
Organizations.createOrganizationAccount(organizationForm) ⇒ Promise
Makes a call to the backend to have an organization account created. (security requires this to be done in a secure environment)
Kind: static method of Organizations
Param | Type |
---|---|
organizationForm | OrganizationFormType |
Organizations.loginOrganization(organization_role) ⇒ Promise
"login" to control of managed organization in specified role
Kind: static method of Organizations
Param | Type |
---|---|
organization_role | RoleType |
Organizations.logoutOrganization() ⇒ Promise
Kind: static method of Organizations
Organizations.makeActiveOrganization(organization_role) ⇒ Promise.<void>
accepts the selected "organization_role" and uses it login & setup control of the indicated organization.
Kind: static method of Organizations
Param | Type |
---|---|
organization_role | RoleType |
Organizations.retireActiveOrganization() ⇒ void
marks the current actiively managed organization to be "retired" This STARTS the action - it does not complete initial
Kind: static method of Organizations
Organizations.subscribeOrganization(organizationID) ⇒ string
Sets up a listener/subscriber object in the Store for a specified organization
Kind: static method of Organizations
Returns: string - the key where this listener was stored in the listener strcuture
Param | Type |
---|---|
organizationID | string |
Organizations.listenOrganization(uid) ⇒ callback
Sets up a listener specifically to the Redux store returns the unsubscribe function; will be called AT LEAST ONCE with initial document
Kind: static method of Organizations
Returns: callback - an unsubscribe function
Param | Type | Description |
---|---|---|
uid | string | UID of the Organization record for the Redux store to listen too. |
Organizations.disableOrganization() ⇒ void
Dispatches the action to disable management of the currently managed organization
Kind: static method of Organizations
Organizations.listenOrganizations(dataCallback, errCallback) ⇒ callback
Sets up and returns a listener object for ALL organization records. Not very useful
Kind: static method of Organizations
Returns: callback - unsubscribe function
Param | Type | Description |
---|---|---|
dataCallback | callback | for Data actions |
errCallback | callback | for error actions |
Organizations.listenOrganizationsPaginated(dataCallback, errCallback, pageSize, optional) ⇒ PaginatedListener
Sets up and returns a paginated listener object for organization records. Allows paging through large number of records, while listenming for changes
Kind: static method of Organizations
Returns: PaginatedListener - Paginated Listener Class object
Param | Type | Description |
---|---|---|
dataCallback | callback | for Data actions |
errCallback | callback | for error actions |
pageSize | number | sets the size of each page of results |
optional | Array.FilterObject | filters for operation |
Payment
People
- People
- .InitAuthListener ⇒ callback
- .setClaims(newClaims) ⇒ ActionItem
- .makeActivePerson(user) ⇒ Promise
- .retireActivePerson() ⇒ Promise
- .ListenPerson(user) ⇒ callback
- .savePerson(person) ⇒ Promise
- .savePayment(person, payment_object) ⇒ Promise
- .CreateAnonymousFan() ⇒ Promise
- .signInSuccessWithAuthResult(authResult, redirectURL) ⇒ boolean
People.InitAuthListener ⇒ callback
Starts the authentication system with status listener
Kind: static constant of People
People.setClaims(newClaims) ⇒ ActionItem
Sets the various Redux states for all claims currently active
Kind: static method of People
Param | Type |
---|---|
newClaims | Credentials |
People.makeActivePerson(user) ⇒ Promise
takes an authenticated user and builds the appropriate ActivePeron in the Redux store
Kind: static method of People
Param | Type |
---|---|
user | User |
People.retireActivePerson() ⇒ Promise
Removes Redux records and authentication for current User
Kind: static method of People
People.ListenPerson(user) ⇒ callback
returns the unsubscribe function; will be called AT LEAST ONCE with initial document
Kind: static method of People
Returns: callback - unsubscribe function
Param | Type |
---|---|
user | User |
People.savePerson(person) ⇒ Promise
Saves an (updated) PersonObject back to Database Store
Kind: static method of People
Param | Type |
---|---|
person | PersonObject |
People.savePayment(person, payment_object) ⇒ Promise
Saves an (updated) PaymentObject to a specified PersonObject back to Database Store
Kind: static method of People
Param | Type |
---|---|
person | PersonObject |
payment_object | PaymentObject |
People.CreateAnonymousFan() ⇒ Promise
calls authentication service. Listener (below) responds to status change
Kind: static method of People
People.signInSuccessWithAuthResult(authResult, redirectURL) ⇒ boolean
Dummt functin for auth UI. We use Async listeners to accomplish the related functions
Kind: static method of People
Param | Type |
---|---|
authResult | object |
redirectURL | string |
Regions
- Regions
- .fetchRegions() ⇒ Array.RegionType
- .fetchRegion() ⇒ RegionType
- .fetchFormattedRegion() ⇒ string
- .ListenRegions() ⇒ callback
Regions.fetchRegions() ⇒ Array.RegionType
returns an array of Region Objects (or err)
Kind: static method of Regions
Regions.fetchRegion() ⇒ RegionType
Returns specified RegionObject
Kind: static method of Regions
Regions.fetchFormattedRegion() ⇒ string
Returns specified RegionObject as a formatted string
Kind: static method of Regions
Returns: string - formatted Region
Regions.ListenRegions() ⇒ callback
Kind: static method of Regions
Roles
- Roles
- .ListenRoles() ⇒ callback
- .offerAccess(parent, offer) ⇒ Promise
Roles.ListenRoles() ⇒ callback
Kind: static method of Roles
Roles.offerAccess(parent, offer) ⇒ Promise
Kind: static method of Roles
Param | Type |
---|---|
parent | OrganizationType |
offer | AccessOffer |
Skills
- Skills
- .fetchFormattedSkill ⇒ SkillObject
- .fetchSkills() ⇒ Array.SkillObject
- .fetchSkill(skillID) ⇒ SkillObject
- .ListenSkills() ⇒ callback
Skills.fetchFormattedSkill ⇒ SkillObject
Fetch a single SkillObject from the store by Id and returns as formatted string
Kind: static constant of Skills
Param | Type |
---|---|
skillID | string |
Skills.fetchSkills() ⇒ Array.SkillObject
Kind: static method of Skills
Skills.fetchSkill(skillID) ⇒ SkillObject
Fetch a single SkillObject from the store by Id
Kind: static method of Skills
Param | Type |
---|---|
skillID | string |
Skills.ListenSkills() ⇒ callback
Kind: static method of Skills
Returns: callback - unsubscribe function
Utilities
Utility Browser support functions
- Utilities
- static
- .fetchLinkedItem(type, link, refPath) ⇒ Promise.RecordDocument
- .fetchSubItem(type, refPath) ⇒ Promise.RecordDocument
- .fetchType(type, refPath) ⇒ Promise.Array.RecordDocument
- .selectAccountData(state, type)
- .searchType(type, prompt, limit) ⇒ Promise.<HostArray>
- .processTarget(target) ⇒ object
- .processItemType(item, type, refPath) ⇒ Promise.RecordDocument
- .formatLinkedItem(link, type, refPath) ⇒ Promise.string
- .summarizeItem(item, type) ⇒ string
- .findIconName(url) ⇒ string
- .typedSortArray(type) ⇒ Array.SortObject
- inner
- ~stripDocIdFromRefPath(refPath) ⇒ string
- ~HostArray : ArtistFormType | VenueType
- static
Utilities.fetchLinkedItem(type, link, refPath) ⇒ Promise.RecordDocument
used generic for constructing forms for input and display
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
type | string | refers to the sub-collection name |
link | string | refers to the linking "value" - a documentID |
refPath | string | optionally refers to the "/" separate path to the parent document in firebase |
Utilities.fetchSubItem(type, refPath) ⇒ Promise.RecordDocument
some items are stored in the database as a single-record collection, using the same Id as the parent
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
type | string | refers to the sub-collection name |
refPath | string | refers to the "/" separate path to the required parent document in firebase |
Utilities.fetchType(type, refPath) ⇒ Promise.Array.RecordDocument
returns an entire sub-collection by "type" (sub-collection name). If refpath is omitted, assumes "type" is a top-level collection
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
type | string | refers to the sub-collection name |
refPath | string | optionally refers to the "/" separate path to the parent document in firebase |
Utilities.selectAccountData(state, type)
parameterized selector
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
state | ReduxStore | Redux State/Store |
type | string |
Utilities.searchType(type, prompt, limit) ⇒ Promise.<HostArray>
This function is a parameterized selector
Kind: static method of Utilities
Returns: Promise.<HostArray> - - returns an array of results, up to limit
Param | Type | Description |
---|---|---|
type | "MANAGEDARTISTS" | "MANAGEDVENUES" | type of list to select. Returns {null} for others |
prompt | string | "search" string (starts-with) |
limit | number | limit results (from start) |
Utilities.processTarget(target) ⇒ object
Generic synchronous form processing function - handles values and returns results as a keyed object
Kind: static method of Utilities
Param | Type |
---|---|
target | eventTarget |
Utilities.processItemType(item, type, refPath) ⇒ Promise.RecordDocument
generic form data processing for database by "type" (collection name)
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
item | RecordDocument | |
type | string | refers to the sub-collection name |
refPath | string | optionally refers to the "/" separate path to the parent document in firebase |
Utilities.formatLinkedItem(link, type, refPath) ⇒ Promise.string
fetches a sub-record from the database and returns the result as a summary string
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
link | string | refers to the linking "value" - a documentID |
type | string | refers to the sub-collection name |
refPath | string | refers to the "/" separate path to the required parent document in firebase |
Utilities.summarizeItem(item, type) ⇒ string
parameterized function to return string summary of an object By default, returns the "name" property of the item.
Kind: static method of Utilities
Param | Type | Description |
---|---|---|
item | object | data object to summarize |
type | String | "People" | "Addresses" | "accessControl" | - type of the object to summarize |
Utilities.findIconName(url) ⇒ string
Hacky way to match Icons to urlLowerCase
Kind: static method of Utilities
Param | Type |
---|---|
url | string |
Utilities.typedSortArray(type) ⇒ Array.SortObject
Firebase query support - builds default sort options
Kind: static method of Utilities
Param | Type |
---|---|
type | string |
Utilities~stripDocIdFromRefPath(refPath) ⇒ string
pulls the document Id from a passed refPath string (firebase dependent)
Kind: inner method of Utilities
Returns: string - Id
Param | Type |
---|---|
refPath | string |
Utilities~HostArray : ArtistFormType | VenueType
Kind: inner typedef of Utilities
Boilerplate
Boilerplate and generic constants and functions for browser Support
- Boilerplate
- static
- inner
Boilerplate.subscriberGenerator(sliceName, tableName, filterArray, sortArray, reference, atRoot, transformer) ⇒ string
Sets up a listener, and starts it running, in the Listener Store
Kind: static method of Boilerplate
Returns: string - listenerStore slot key
Param | Type | Description |
---|---|---|
sliceName | string | name of "slice" of redux store to save subscribed data typeof |
tableName | string | name of specific database table to listen to, same as Redux location to save to |
filterArray | Array.FilterObject | |
sortArray | Array.SortObject | |
reference | string | path to base "tableName" from |
atRoot | boolean | simplifies listener functions is at atRoot |
transformer | callback | optional function to "transform" data results |
Boilerplate~ListenGenerator(sliceName, tableName, filterArray, sortArray, transformer) ⇒ callback
Sets up a listener for the Listener Store Assumes a CollectionGroup query
Kind: inner method of Boilerplate
Returns: callback - unsubscribe function
Param | Type | Default | Description |
---|---|---|---|
sliceName | string | name of "slice" of redux store to save subscribed data typeof | |
tableName | string | name of specific database table to listen to, same as Redux location to save to | |
filterArray | Array.FilterObject | ||
sortArray | Array.SortObject | ||
transformer | callback | optional function to "transform" data results |
Boilerplate~ListenShallowGenerator(sliceName, tableName, filterArray, sortArray, reference, transformer) ⇒ callback
Sets up a listener for the Listener Store Assumes a simple Collection query
Kind: inner method of Boilerplate
Returns: callback - unsubscribe function
Param | Type | Default | Description |
---|---|---|---|
sliceName | string | name of "slice" of redux store to save subscribed data typeof | |
tableName | string | name of specific database table to listen to, same as Redux location to save to | |
filterArray | Array.FilterObject | ||
sortArray | Array.SortObject | ||
reference | string | path to base "tableName" from | |
transformer | callback | optional function to "transform" data results |
Constants
Browser access and themeing constants
- Constants
- static
- .COMPANY_NAME
- .TWITTER_ACCOUNT
- .FACEBOOK_ACCOUNT
- .INSTAGRAM_ACCOUNT
- .LINKEDIN_ACCOUNT
- .EMAIL_ACCOUNT
- .PAYMENT_THEME
- .CANCELED_EVENT
- .UNBOOKED
- .UNBOOKED_EVENT
- .OPEN
- .OPEN_OFFER
- .WORKING
- .WORKING_OFFER
- .BOOKED
- .BOOKED_EVENT
- .SHOWS_EVENT
- .TOUR
- .INITIAL_SHOW_COUNT
- .NATION_ZOOM
- .REGION_ZOOM
- .VENUE_ZOOM
- .LABELSTYLE
- .REGION_MARKER
- .labelStyle
- .set_theme()
- .editInPlaceSelectStyles()
- inner
- static
Constants.COMPANY_NAME
variable for shared Company Name
Kind: static property of Constants
Constants.TWITTER_ACCOUNT
variable for shared Twitter Name
Kind: static property of Constants
Constants.FACEBOOK_ACCOUNT
variable for shared Facebook Name
Kind: static property of Constants
Constants.INSTAGRAM_ACCOUNT
variable for shared Instagram Name
Kind: static property of Constants
Constants.LINKEDIN_ACCOUNT
variable for shared LinkedIn Name
Kind: static property of Constants
Constants.EMAIL_ACCOUNT
variable for shared Email Name
Kind: static property of Constants
Constants.PAYMENT_THEME
variable for shared Payment Name
Kind: static property of Constants
Constants.CANCELED_EVENT
Kind: static constant of Constants
Default: "Show Canceled"
Constants.UNBOOKED
Kind: static constant of Constants
Default: "unbooked"
Constants.UNBOOKED_EVENT
Kind: static constant of Constants
Default: "Tour Stop"
Constants.OPEN
Kind: static constant of Constants
Default: "open"
Constants.OPEN_OFFER
Kind: static constant of Constants
Default: "open"
Constants.WORKING
Kind: static constant of Constants
Default: "working"
Constants.WORKING_OFFER
Kind: static constant of Constants
Default: "working"
Constants.BOOKED
Kind: static constant of Constants
Default: "booked"
Constants.BOOKED_EVENT
Kind: static constant of Constants
Default: "Show"
Constants.SHOWS_EVENT
Kind: static constant of Constants
Default: "Show"
Constants.TOUR
Kind: static constant of Constants
Default: "tour"
Constants.INITIAL_SHOW_COUNT
Kind: static constant of Constants
Default: 5
Constants.NATION_ZOOM
Kind: static constant of Constants
Default: 3
Constants.REGION_ZOOM
Kind: static constant of Constants
Default: 10
Constants.VENUE_ZOOM
Kind: static constant of Constants
Default: 18
Constants.LABELSTYLE
Kind: static constant of Constants
Constants.REGION_MARKER
Kind: static constant of Constants
Default: BLUE_MARKER
Constants.labelStyle
Kind: static constant of Constants
Constants.set_theme()
Sets the theme to default/current values
Kind: static method of Constants
Constants.editInPlaceSelectStyles()
Edit In Place constants all the below accomplishes a "select-in-place"
Kind: static method of Constants
Constants~gigstartr_constants
Kind: inner constant of Constants
Default: {"company_name":"GiGStartr","twitter_account":"Gig_Startr","facebook_account":"GigStartr","instagram_account":"gigstartr","linkedin_account":"gigstartr","email_account":"info@gigstarter.com","logoFont":"DCC Ash","titleFont":"Faustina","themeFont":"Faustina","themeBackgroundColor":"#ccbebe","themeColor":"#181818","themeAccent":"#726b6b","themeShadows":"#d7ecfa","ThemeDarkColor":"#8a8a8a","themeBorderColor":"#cacaca","themeReverse":"#fefefe","themeReverseText":"#181818","palePrimaryColor":"#d7ecfa","secondaryColor":"#767676","paleSecondaryColor":"#eaeaea","successColor":"#3adb76","paleSuccessColor":"#e1faea","warningColor":"#ffae00","paleWarningColor":"#fff3d9","alertColor":"#cc4b37","paleAlertColor":"#f9ecea","themeBooked":"goldenrod","themeUnbooked":"blue","themeOpen":"green","themeWorking":"orange","themePledge":"green","themeTicket":"FireBrick","themeTour":"black","paymentTheme":"stripe"}
Constants~gigstartr_dark
Kind: inner constant of Constants
Default: {"company_name":"GiGStartr","twitter_account":"Gig_Startr","facebook_account":"GigStartr","instagram_account":"gigstartr","linkedin_account":"gigstartr","email_account":"info@gigstarter.com","logoFont":"DCC Ash","titleFont":"Faustina","themeFont":"Faustina","themeBackgroundColor":"#181818","themeAccent":"#606060","themeColor":"#efefef","themeShadows":"#d7ecfa","ThemeDarkColor":"#8a8a8a","themeBorderColor":"#cacaca","themeReverse":"#fefefe","themeReverseText":"#181818","palePrimaryColor":"#606060","secondaryColor":"#767676","paleSecondaryColor":"#eaeaea","successColor":"#3adb76","paleSuccessColor":"#e1faea","warningColor":"#ffae00","paleWarningColor":"#fff3d9","alertColor":"#cc4b37","paleAlertColor":"#f9ecea","themeBooked":"goldenrod","themeUnbooked":"blue","themeOpen":"green","themeWorking":"orange","themePledge":"green","themeTicket":"FireBrick","themeTour":"black","paymentTheme":"night"}
Constants~gigison_constants
Kind: inner constant of Constants
Default: {"company_name":"GIGisON","twitter_account":"gigisonsocial","facebook_account":"gigisonsocial","instagram_account":"gigisonsocial","linkedin_account":"gigstartr","email_account":"info@gigison.com","logoFont":"Galyon Bold","titleFont":"Stone Sans Semi Bold","themeFont":"Stone Sans","themeBackgroundColor":"#fff","themeAccent":"#666","themeColor":"#181818","themeShadows":"#181818","ThemeDarkColor":"#8a8a8a","themeBorderColor":"#cacaca","themeReverse":"#181818","themeReverseText":"#fefefe","palePrimaryColor":"#d7ecfa","secondaryColor":"#767676","paleSecondaryColor":"#eaeaea","successColor":"#3adb76","paleSuccessColor":"#e1faea","warningColor":"#ffae00","paleWarningColor":"#fff3d9","alertColor":"#cc4b37","paleAlertColor":"#f9ecea","themeBooked":"goldenrod","themeUnbooked":"blue","themeOpen":"green","themeWorking":"goldenrod","themePledge":"green","themeTicket":"FireBrick","themeTour":"black","paymentTheme":"stripe"}
Constants~themes
Kind: inner constant of Constants
Default: "gigstartr_dark","gigstartr_constants","gigison_constants"
PledgeTickets
PledgeTickets.listenPledgeTickets(event, dataCallback, errCallback) ⇒ callback
Attaches a listener to the event's pledgetickets (if any) returns the unsubscribe function; will be called AT LEAST ONCE with initial document
Kind: static method of PledgeTickets
Returns: callback - a unsubscribe function to dismiss the listener
Param | Type | Description |
---|---|---|
event | EventType | event record (with refPath) to get pledgeTickets from |
dataCallback | callback | a callback function to call when when there is an update event on the pledgeTickets attached to the event |
errCallback | callback | a callback function for error conditions |
PledgeTickets.browserCheckIn(pledgeTicket, newCheckIn) ⇒ Promise
Calls Function Server to securely create a CheckIn
Kind: static method of PledgeTickets
Param | Type |
---|---|
pledgeTicket | PledgeTicketType |
pledgeTicket.refPath | string |
newCheckIn | object |
ConfigureStore
Customzied Redux Store and support - legacy naming
- ConfigureStore
- static
- .store : ReduxStore
- inner
- static
ConfigureStore.store : ReduxStore
Kind: static constant of ConfigureStore
ConfigureStore~asyncReducers : object
Initializes a dictionary to keep track of the registered async reducers
Kind: inner property of ConfigureStore
ConfigureStore~listeners : object
Initializes a dictionary to keep track of registered defered inits
Kind: inner property of ConfigureStore
ConfigureStore~injectReducer(key, asyncReducer)
Kind: inner method of ConfigureStore
Param | Type | Description |
---|---|---|
key | string | unique key/name |
asyncReducer | callback |
ConfigureStore~injectListener(key, listener, deleteOnSub)
Kind: inner method of ConfigureStore
Param | Type | Description |
---|---|---|
key | string | unique string to identify this listener |
listener | function | function that establishes a database listener; expects function to return an unsubscribe function. |
deleteOnSub | boolean | flag to indicate whether to delete the listener altogether when unsubscribed (removes from defers) |
ConfigureStore~runListener(key)
Runs a specific listener by Key
Kind: inner method of ConfigureStore
Param | Type | Description |
---|---|---|
key | string | unique string to identify which listener to start expects the listener to return an unsubscribe function to be saved |
ConfigureStore~deferred()
Runs all defered listeners
Kind: inner method of ConfigureStore
ConfigureStore~unsubscribeListeners()
Calls all listener's unsubscribe functions
Kind: inner method of ConfigureStore
ConfigureStore~createReducer(asyncReducers)
takes an array of reducers (possibly async) and returns a single reducer structure
Kind: inner method of ConfigureStore
Param | Type |
---|---|
asyncReducers | Array.callback |
ConfigureStore~ReduxStore : object
Kind: inner typedef of ConfigureStore
ReduxStore
Redux Store and State modules
CityManagerRedux
CityManager Redux store & actions
EventGroupsRedux
Redux slice
FundamentalsRedux
GenresRedux
ImagesRedux
OrganizationRedux
Organization Redux store & actions
PaymentRedux
PeopleRedux
RegionsRedux
RolesRedux
SkillsRedux
BoilerplateRedux
Generic Redux functions and constants
- BoilerplateRedux
- static
- inner
- ~ActionItem : object
BoilerplateRedux.setGeneric ⇒ ActionItem
Creates and dispatches an ActionItem based on the "slice" name, specific action type, and payload
Kind: static constant of BoilerplateRedux
Param | Type | Description |
---|---|---|
sliceName | string | |
specific | string | action type |
payload | object |
BoilerplateRedux.BROWSINGDATE
Kind: static constant of BoilerplateRedux
BoilerplateRedux.genericReduxAction(sliceName, specific, payload) ⇒ ActionItem
Creates and returns an ActionItem based on the "slice" name, specific action type, and payload
Kind: static method of BoilerplateRedux
Param | Type | Description |
---|---|---|
sliceName | string | |
specific | string | action type |
payload | object |
BoilerplateRedux.selectGeneric(state, sliceName, which)
gets Redux information by "slice" (really, which reducer) and "which" (table name) Synchronous to state changes
Kind: static method of BoilerplateRedux
Param | Type | Description |
---|---|---|
state | ReduxState | Redux state/store |
sliceName | string | a name to identify the reducer/state segment |
which | string | the name of the sub-table ("specific type") |
BoilerplateRedux.getGeneric(sliceName, which)
gets Redux information by "slice" (really, which reducer) and "which" (table name) Asynchronous to state changes
Kind: static method of BoilerplateRedux
Param | Type | Description |
---|---|---|
sliceName | string | a name to identify the reducer/state segment |
which | string | the name of the sub-table ("specific type") |
BoilerplateRedux~ActionItem : object
Kind: inner typedef of BoilerplateRedux
Properties
Name | Type |
---|---|
type | string |
payload | object |
CityManagerActions
CityManager Redux actions
- CityManagerActions
- .SET_ACTIVE_CITYMANAGER
- .CREATE_NEW_CITYMANAGER
- .CREATE_NEW_AND_USE_CITYMANAGER
- .ADD_CITYMANAGER
- .REPLACE_CITYMANAGER
- .SAVE_CITYMANAGER
- .CLEAR_CITYMANAGER
- .CITYMANAGER_SLICE
- .CITYMANAGER_EVENTS
- .setActiveCityManagerAction(cityManager) ⇒ ActionItem
- .setActiveCityManager(organization) ⇒ ActionItem
- .setCityManagerInflight(inflight) ⇒ ActionItem
- .getCityManagerInflight(state) ⇒ boolean
- .fetchCityManagerInflight() ⇒ boolean
- .getActiveCityManager(state) ⇒ CityManagerType
- .getManagedCityManagers(state) ⇒ Array.AccessItem
CityManagerActions.SET_ACTIVE_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "SET_ACTIVE_CITYMANAGER"
CityManagerActions.CREATE_NEW_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "CREATE_NEW_CITYMANAGER"
CityManagerActions.CREATE_NEW_AND_USE_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "CREATE_NEW_AND_USE_CITYMANAGER"
CityManagerActions.ADD_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "ADD_CITYMANAGER"
CityManagerActions.REPLACE_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "REPLACE_CITYMANAGER"
CityManagerActions.SAVE_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "SAVE_CITYMANAGER"
CityManagerActions.CLEAR_CITYMANAGER
Kind: static constant of CityManagerActions
Default: "CLEAR_CITYMANAGER"
CityManagerActions.CITYMANAGER_SLICE
Kind: static constant of CityManagerActions
Default: CITYMANAGER
CityManagerActions.CITYMANAGER_EVENTS
Kind: static constant of CityManagerActions
Default: "Events"
CityManagerActions.setActiveCityManagerAction(cityManager) ⇒ ActionItem
Kind: static method of CityManagerActions
Param | Type |
---|---|
cityManager | CityManagerType |
CityManagerActions.setActiveCityManager(organization) ⇒ ActionItem
Creates and dispatches the action
Kind: static method of CityManagerActions
Param | Type |
---|---|
organization | OrganizationType |
CityManagerActions.setCityManagerInflight(inflight) ⇒ ActionItem
Creates and dispatches the cityManager update inflight status
Kind: static method of CityManagerActions
Param | Type |
---|---|
inflight | boolean |
CityManagerActions.getCityManagerInflight(state) ⇒ boolean
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of CityManagerActions
Param | Type |
---|---|
state | ReduxState |
CityManagerActions.fetchCityManagerInflight() ⇒ boolean
reads the item from current state. Asynchronous to state changes
Kind: static method of CityManagerActions
CityManagerActions.getActiveCityManager(state) ⇒ CityManagerType
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of CityManagerActions
Param | Type |
---|---|
state | ReduxState |
CityManagerActions.getManagedCityManagers(state) ⇒ Array.AccessItem
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of CityManagerActions
Param | Type |
---|---|
state | ReduxState |
EventGroupsActions
Action Support
EventGroupsActions.SET_EVENTGROUPS
Kind: static constant of EventGroupsActions
EventGroupsActions.setEventGroups(eventGroups) ⇒ ActionObject
action function to store eventGroups in Reducer
Kind: static method of EventGroupsActions
Param | Type |
---|---|
eventGroups | Array.EventGroupType |
GenresActions
- GenresActions
- .LOAD_GENRES
- .loadGenres(genres) ⇒ ActionItem
- .updateGenres(genres) ⇒ ActionItem
- .genreList() ⇒ Array.GenreObject
- .selectGenres(state) ⇒ Array.GenreObject
GenresActions.LOAD_GENRES
Kind: static constant of GenresActions
Default: "LOAD_GENRES"
GenresActions.loadGenres(genres) ⇒ ActionItem
creates a loadGenres ActionItem
Kind: static method of GenresActions
Param | Type |
---|---|
genres | Array.GenreObject |
GenresActions.updateGenres(genres) ⇒ ActionItem
creates and dispatches a loadGenres ActionItem
Kind: static method of GenresActions
Param | Type |
---|---|
genres | Array.GenreObject |
GenresActions.genreList() ⇒ Array.GenreObject
creates a muttable copy of Gneres from the redux sture
Kind: static method of GenresActions
GenresActions.selectGenres(state) ⇒ Array.GenreObject
Returns a state slice for lifecycle operations
Kind: static method of GenresActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions
Redux actions related to Organizations
- OrganizationActions
- .SET_ACTIVE_ORGANIZATION
- .ORGANIZATION_SLICE
- .getManagedOrganizations ⇒ Array.AccessItem
- .setActiveOrganizationAction(organization) ⇒ ActionItem
- .setActiveOrganization(organization) ⇒ ActionItem
- .setOrganizationBrowsingDate(date) ⇒ ActionItem
- .getOrganizationBrowsingDate(state) ⇒ dateString
- .setOrganizationRegionPreference(region) ⇒ ActionItem
- .getOrganizationRegionPreference(state) ⇒ RegionType
- .fetchOrganizationRegionPreference() ⇒ RegionType
- .setOrganizationListPreference(isList) ⇒ ActionItem
- .getOrganizationListPreference(state) ⇒ boolean
- .fetchOrganizationListPreference() ⇒ boolean
- .setOrganizationCalendarView(view) ⇒ ActionItem
- .getOrganizationCalendarView(state) ⇒ CalendarViewType
- .fetchOrganizationCalendarView() ⇒ CalendarViewType
- .setOrganizationInflight(inflight) ⇒ ActionItem
- .getOrganizationInflight(state) ⇒ boolean
- .fetchOrganizationInflight() ⇒ boolean
- .readActiveOrganization() ⇒ OrganizationType
- .getActiveOrganization(state) ⇒ Organization
- .getActiveOrganizationID(state) ⇒ boolean
OrganizationActions.SET_ACTIVE_ORGANIZATION
Kind: static constant of OrganizationActions
Read only: true
OrganizationActions.ORGANIZATION_SLICE
Kind: static constant of OrganizationActions
Read only: true
OrganizationActions.getManagedOrganizations ⇒ Array.AccessItem
Retrieves the item from synchronous passed (i.e. active) state
Kind: static constant of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.setActiveOrganizationAction(organization) ⇒ ActionItem
creates the action item for dispatching
Kind: static method of OrganizationActions
Param | Type |
---|---|
organization | OrganizationType |
OrganizationActions.setActiveOrganization(organization) ⇒ ActionItem
Creates and dispatches the action
Kind: static method of OrganizationActions
Param | Type |
---|---|
organization | OrganizationType |
OrganizationActions.setOrganizationBrowsingDate(date) ⇒ ActionItem
Kind: static method of OrganizationActions
Param | Type |
---|---|
date | dateString |
OrganizationActions.getOrganizationBrowsingDate(state) ⇒ dateString
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.setOrganizationRegionPreference(region) ⇒ ActionItem
Creates and dispatches the action item
Kind: static method of OrganizationActions
Param | Type |
---|---|
region | string |
OrganizationActions.getOrganizationRegionPreference(state) ⇒ RegionType
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.fetchOrganizationRegionPreference() ⇒ RegionType
reads the item from current state. Asynchronous to state changes
Kind: static method of OrganizationActions
OrganizationActions.setOrganizationListPreference(isList) ⇒ ActionItem
Creates and dispatches the organization listing choice
Kind: static method of OrganizationActions
Param | Type |
---|---|
isList | boolean |
OrganizationActions.getOrganizationListPreference(state) ⇒ boolean
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.fetchOrganizationListPreference() ⇒ boolean
reads the item from current state. Asynchronous to state changes
Kind: static method of OrganizationActions
OrganizationActions.setOrganizationCalendarView(view) ⇒ ActionItem
Creates and dispatches the organization callendar view choice
Kind: static method of OrganizationActions
Param | Type |
---|---|
view | CalendarViewType |
OrganizationActions.getOrganizationCalendarView(state) ⇒ CalendarViewType
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.fetchOrganizationCalendarView() ⇒ CalendarViewType
reads the item from current state. Asynchronous to state changes
Kind: static method of OrganizationActions
OrganizationActions.setOrganizationInflight(inflight) ⇒ ActionItem
Creates and dispatches the organization update inflight choice
Kind: static method of OrganizationActions
Param | Type |
---|---|
inflight | boolean |
OrganizationActions.getOrganizationInflight(state) ⇒ boolean
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.fetchOrganizationInflight() ⇒ boolean
reads the item from current state. Asynchronous to state changes
Kind: static method of OrganizationActions
OrganizationActions.readActiveOrganization() ⇒ OrganizationType
reads the item from current state. Asynchronous to state changes
Kind: static method of OrganizationActions
OrganizationActions.getActiveOrganization(state) ⇒ Organization
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
OrganizationActions.getActiveOrganizationID(state) ⇒ boolean
Retrieves the item from synchronous passed (i.e. active) state
Kind: static method of OrganizationActions
Param | Type |
---|---|
state | ReduxState |
SkillsActions
- SkillsActions
- .LOAD_SKILLS
- .loadSkills(skills) ⇒ ActionItem
- .updateSkills(skills) ⇒ ActionItem
- .skillList() ⇒ Array.SkillObject
- .selectSkills(state) ⇒ Array.SkillObject
SkillsActions.LOAD_SKILLS
Kind: static constant of SkillsActions
Default: "LOAD_SKILLS"
SkillsActions.loadSkills(skills) ⇒ ActionItem
Returns an ActionItem
Kind: static method of SkillsActions
Param | Type |
---|---|
skills | Array.SkillsObject |
SkillsActions.updateSkills(skills) ⇒ ActionItem
Creates and Dispathes an ActionItem
Kind: static method of SkillsActions
Param | Type |
---|---|
skills | Array.SkillsObject |
SkillsActions.skillList() ⇒ Array.SkillObject
Kind: static method of SkillsActions
SkillsActions.selectSkills(state) ⇒ Array.SkillObject
Kind: static method of SkillsActions
Param | Type |
---|---|
state | ReduxSlice |
CityManagerReducer
CityManager Redux reducers
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
module.exports~InitialStateBob
Initial State
Kind: inner constant of module.exports
Default: {"cityManager":null,"activeCityManager":null}
EventGroupReducer
Reducer Support
- EventGroupReducer
- module.exports(state, action) ⇒ ReduxSlice ⏏
module.exports(state, action) ⇒ ReduxSlice ⏏
EventGroup Reducer
Kind: Exported function
Param | Type | Description |
---|---|---|
state | ReduxSlice | state local to this slice |
action | ActionObject |
module.exports~InitialState
Kind: inner constant of module.exports
Default: []
FundamentalsReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
module.exports~InitialState
Kind: inner constant of module.exports
Default: {}
GenresReducer
- GenresReducer
- module.exports(state, action) ⇒ ReduxSlice ⏏
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
module.exports~InitialState
Kind: inner constant of module.exports
Default: {"genres":null}
ImagesReducer
- ImagesReducer
- module.exports(state, action) ⇒ ReduxSlice ⏏
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
module.exports~InitialState
Kind: inner constant of module.exports
Default: {"image":null,"banner":null,"loading":null}
OrganizationReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
PaymentReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
PeopleReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
RegionsReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
RolesReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
SkillsReducer
module.exports(state, action) ⇒ ReduxSlice ⏏
reducer
Kind: Exported function
Param | Type |
---|---|
state | ReduxSlice |
action | ActionItem |
getRole(roleId) ⇒ Role
Kind: global function
Param | Type | Description |
---|---|---|
roleId | string | Id associated with a role |
© 2020-2023 Tracy Hall
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago