Book Playground

0x9c4287525999893bf730134f74e69e4a6f8973b6 Copy

About

Stats

Public Functions 42

Event Types 5

Code Size 24,207 bytes

Library Use

Uses SafeMath for uint256.

Uses StringUtil for string.

Events (5)

AddedToGroup Event

Parameters

groupId	uint8
account	address

FileChanged Event

Parameters

indexedFolder	string
indexedFile	string
folderName	string
fileName	string
data	string

FileRemoved Event

Parameters

indexedFolder	string
indexedFile	string
folderName	string
fileName	string

FileRenamed Event

Parameters

indexedFolder	string
indexedFile	string
folderName	string
fileName	string
newName	string

RemovedFromGroup Event

Parameters

groupId	uint8
account	address

Structs (2)

File Struct

Members

exists	bool
index	uint64
name	string
data	string
creator	address

Folder Struct

Members

exists	bool
index	uint64
accessToken	Erc20Subset
name	string
metadata	string
encoding	string
fileNames	string[]
files	mapping(string => File)

Constants (3)

ADMIN Constant

uint8

WRITER Constant

uint8

EDITOR Constant

uint8

State Variables (12)

bwtype Variable

uint256

bwver Variable

uint256

name Variable

string

defaultEncoding Variable

string

defaultAccessToken Variable

address

authoringRestricted Variable

bool

creatorEditing Variable

bool

directEditing Variable

bool

bookExtension Variable

address

folderNames Variable

string[]

Internal Variable

folders Variable

mapping(string => Folder)

Internal Variable

groups Variable

Groups.GroupMap

Internal Variable

Functions Expand All Collapse All

addAdmin

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

null

removeAdmin

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

null

addWriter

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

One or more of the following: -null - ORnull

removeWriter

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

One or more of the following: -null - ORnull

addEditor

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

null

removeEditor

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability transaction

Requirements

null

isAdmin

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

isWriter

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

isWriterOrEditor

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

isEditor

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

isEditorOrAdmin

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

setBookExtension

Parameters

Name	Type
extension	BookExtension

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setAuthoringRestricted

Parameters

Name	Type
restricted	bool

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setDirectEditing

Parameters

Name	Type
allowed	bool

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setCreatorEditing

Parameters

Name	Type
enabled	bool

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setDefaultEncoding

Parameters

Name	Type
encoding	string

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setDefaultAccessToken

Parameters

Name	Type
token	Erc20Subset

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

updateAccessTokens

Parameters

Name	Type
fromToken	Erc20Subset
toToken	Erc20Subset

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

null

setAccessToken

Parameters

Name	Type
folderName	string
token	Erc20Subset

Properties

Visibility public

Mutability transaction

Requirements

null

setMetadata

Parameters

Name	Type
folderName	string
metadata	string

Properties

Visibility public

Mutability transaction

Requirements

null

setEncoding

Parameters

Name	Type
folderName	string
encoding	string

Properties

Visibility public

Mutability transaction

Requirements

null

set

Parameters

Name	Type
folderName	string
fileName	string
data	string

Properties

Visibility public

Mutability transaction

Requirements

directEditing must be true

extensionSet

Parameters

Name	Type
folderName	string
fileName	string
data	string
creator	address

Properties

Visibility public

Mutability transaction

Requirements

the sender's address must be equal to UNKNOWN VALUE

remove

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability transaction

Requirements

directEditing must be true

rename

Parameters

Name	Type
folderName	string
fileName	string
newName	string

Properties

Visibility public

Mutability transaction

Requirements

directEditing must be true

the result of calling fileExists with folderName, newName must not be true

get

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

fileExists

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

getAddress

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

getUint

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

getFileCreator

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

getFolderCount

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

getFolderSize

Parameters

Name	Type
folderName	string

Properties

Visibility public

Mutability view

getFolderSizeByIndex

Parameters

Name	Type
index	uint64

Properties

Visibility public

Mutability view

getFolderName

Parameters

Name	Type
index	uint64

Properties

Visibility public

Mutability view

getFolderIndex

Parameters

Name	Type
folderName	string

Properties

Visibility public

Mutability view

getFileName

Parameters

Name	Type
folderName	string
index	uint64

Properties

Visibility public

Mutability view

getFileIndex

Parameters

Name	Type
folderName	string
fileName	string

Properties

Visibility public

Mutability view

getAccessToken

Parameters

Name	Type
folderName	string

Properties

Visibility public

Mutability view

getMetadata

Parameters

Name	Type
folderName	string

Properties

Visibility public

Mutability view

getMetadataByIndex

Parameters

Name	Type
index	uint64

Properties

Visibility public

Mutability view

getEncoding

Parameters

Name	Type
folderName	string

Properties

Visibility public

Mutability view

getEncodingByIndex

Parameters

Name	Type
index	uint64

Properties

Visibility public

Mutability view

Internal Functions Expand All Collapse All

Internal functions are parts of the contract that can't be used directly, but instead are used by the public functions listed above.

internal BaseBook.init

Parameters

Name	Type
sender	address

Properties

Visibility internal

Mutability transaction

internal BaseBook.requireWriteAccess

Parameters

Name	Type
account	address
folder	Folder
fileName	string

Properties

Visibility internal

Mutability view

internal BaseBook.getOrCreateFolder

Parameters

Name	Type
folderName	string

Properties

Visibility internal

Mutability transaction

Requirements

the result of calling undefined must not be true

internal BaseBook.getFolder

Parameters

Name	Type
folderName	string

Properties

Visibility internal

Mutability view

internal BaseBook.setFileValue

Parameters

Name	Type
folder	Folder
fileName	string
data	string
creator	address

Properties

Visibility internal

Mutability transaction

internal ContractGroups._addAdmin

Parameters

Name	Type
account	address

Properties

Visibility internal

Mutability transaction

internal ContractGroups._add

Parameters

Name	Type
groupId	uint8
account	address

Properties

Visibility internal

Mutability transaction

internal ContractGroups._remove

Parameters

Name	Type
groupId	uint8
account	address

Properties

Visibility internal

Mutability transaction

internal ContractGroups._contains

Parameters

Name	Type
groupId	uint8
account	address

Properties

Visibility internal

Mutability view

Book Playground

About

Stats

Library Use

Events (5) keyboard_arrow_up

AddedToGroup Event

Parameters help Event parameters list the data that an event contains.

FileChanged Event

Parameters help Event parameters list the data that an event contains.

FileRemoved Event

Parameters help Event parameters list the data that an event contains.

FileRenamed Event

Parameters help Event parameters list the data that an event contains.

RemovedFromGroup Event

Parameters help Event parameters list the data that an event contains.

Structs (2) keyboard_arrow_up

File Struct

Members

Folder Struct

Members

Constants (3) keyboard_arrow_up

ADMIN Constant

WRITER Constant

EDITOR Constant

State Variables (12) keyboard_arrow_up

bwtype Variable

bwver Variable

name Variable

defaultEncoding Variable

defaultAccessToken Variable

authoringRestricted Variable

creatorEditing Variable

directEditing Variable

bookExtension Variable

folderNames Variable

folders Variable

groups Variable

Functions Expand All Collapse All

addAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

removeAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

addWriter keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

removeWriter keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

addEditor keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

removeEditor keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

isAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

isWriter keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

isWriterOrEditor keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

isEditor keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

isEditorOrAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

setBookExtension keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Events (5)

Parameters

Parameters

Parameters

Parameters

Parameters

Structs (2)

Constants (3)

State Variables (12)

addAdmin

Parameters

Requirements

removeAdmin

Parameters

Requirements

addWriter

Parameters

Requirements

removeWriter

Parameters

Requirements

addEditor

Parameters

Requirements

removeEditor

Parameters

Requirements

isAdmin

Parameters

isWriter

Parameters

isWriterOrEditor

Parameters

isEditor

Parameters

isEditorOrAdmin

Parameters

setBookExtension

Parameters

Modifiers

setAuthoringRestricted

Parameters

Modifiers

setDirectEditing

Parameters

Modifiers

setCreatorEditing

Parameters

Modifiers

setDefaultEncoding

Parameters

Modifiers

setDefaultAccessToken

Parameters

Modifiers

updateAccessTokens

Parameters

Modifiers

setAccessToken

Parameters

Requirements

setMetadata

Parameters

Requirements

setEncoding

Parameters

Requirements

set

Parameters

Requirements

extensionSet

Parameters

Requirements

remove

Parameters

Requirements

rename

Parameters

Requirements

get