docgen

Index Home Arana > Arana Architecture > Arana Daemons > docgen

DocGen Daemon

This daemon generates documents and downloads them to the user.  Sometimes this is quick; sometimes this is slow, so consolidating this functionality here saves the applications from being blocked while a requested document is generated.

Messages Received and Processed

Messages Received and Processed

Specific Messages

MsgTag

Description

imagecb


API Messages

MsgTag

Description

dl-Artifact

Request a downloaded document of the Artifact requested.

device - handle to user device where document will transfer to

artifact_id - specific Artifact DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Place

Request a downloaded document of the Place requested.

device - handle to user device where document will transfer to

place_id - specific Place DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-NPC

Request a downloaded document of the NPC requested.

device - handle to user device where document will transfer to

npc_id - specific NPC DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Story

Request a downloaded document of the Story requested.

device - handle to user device where document will transfer to

story_id - specific Story DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Milieu

Request a downloaded document of the Milieu requested.

device - handle to user device where document will transfer to

milieu_id - specific Milieu DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Item

Request a downloaded document of the Item requested.

device - handle to user device where document will transfer to

item_id - specific Item DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Quest

Request a downloaded document of the Quest requested.

device - handle to user device where document will transfer to

quest_id - specific Quest DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Monster

Request a downloaded document of the Monster requested.

device - handle to user device where document will transfer to

monster_id - specific Monster DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Country

Request a downloaded document of the Country requested.

device - handle to user device where document will transfer to

country_id - specific Country DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Encounter

Request a downloaded document of the Encounter requested.

device - handle to user device where document will transfer to

encounter_id - specific Encounter DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Land

Request a downloaded document of the Land requested.

device - handle to user device where document will transfer to

land_id - specific Land DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-MagicDevice

Request a downloaded document of the MagicDevice requested.

device - handle to user device where document will transfer to

magicdevice_id - specific MagicDevice DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Secrets

Request a downloaded document of the Secrets requested.

device - handle to user device where document will transfer to

secrets_id - specific Secrets DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Terrain

Request a downloaded document of the Terrain requested.

device - handle to user device where document will transfer to

terrain_id - specific Terrain DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise

dl-Vendor

Request a downloaded document of the Vendor requested.

device - handle to user device where document will transfer to

vendor_id - specific Vendor DB table id

milieu_id - the Milieu id (context for document)

story_id - the Story id (context for document)

properties - document properties to use when generating document

type - downloadable document type, e.g. html

@return true if request sent; false otherwise