FivePD API
Interfaces

IDepartmentService

Responsible for managing Department objects.

Methods

CreateDepartment

Inserts a Department into the 'departments' table.

Parameters

NameTypeDescription
departmentDepartmentThe department to insert.

Returns

NameType
DepartmentThe created department object with change tracking.

UpdateDepartment

Updates the given department.

Parameters

NameTypeDescription
departmentDepartmentThe department to update.

Returns

NameType
DepartmentThe updated department object with change tracking.

DeleteDepartment

Deletes a Department from the 'departments' table.

Parameters

NameTypeDescription
departmentDepartmentThe department to remove.

CreateDivision

Inserts a Division into the 'divisions' table.

Parameters

NameTypeDescription
divisionDivisionThe division to insert.

Returns

NameType
DivisionThe created division object with change tracking.

UpdateDivision

Updates the given division.

Parameters

NameTypeDescription
divisionDivisionThe division to update.

Returns

NameType
DivisionThe updated division object with change tracking.

DeleteDivision

Deletes a Division from the 'departments' table.

Parameters

NameTypeDescription
divisionDivisionThe department to remove.

GetDepartments

Selects and returns all departments.

Parameters

NameTypeDescription
optionsDepartmentQueryOptionsThe options to use when querying the database.

Returns

NameType
IEnumerable<Department>A list of departments.

GetDepartmentById

Finds the first department with the given identifier.

Parameters

NameTypeDescription
idintThe identifier to search for.
optionsDepartmentQueryOptionsThe options to use when querying the database.

Returns

NameType
DepartmentThe found department.

AddPlayerToDepartment

Adds the given player to the given department.

Parameters

NameTypeDescription
userUserThe user to update.
departmentDepartmentThe department to which the user will be added.

AddPlayerToDepartment

Adds the given player to the given department.

Parameters

NameTypeDescription
playerPlayerThe user to update.
departmentDepartmentThe department to which the user will be added.

RemovePlayerFromDepartment

The given player will be removed from their department.

Parameters

NameTypeDescription
userUserThe user to update.

RemovePlayerFromDepartment

The given player will be removed from their department.

Parameters

NameTypeDescription
playerPlayerThe user to update.

RemovePlayerFromDepartment

The given player will be removed from their department.

Parameters

NameTypeDescription
playerFPlayerThe user to update.

GetPlayerDepartment

Gets the department of the given player.

Parameters

NameTypeDescription
playerPlayerThe player.

Returns

NameType
DepartmentThe department of the player.

GetPlayerDepartment

Gets the department of the given player.

Parameters

NameTypeDescription
playerFPlayerThe player.

Returns

NameType
DepartmentThe department of the player.

Events

DepartmentCreated

Fires when a department has been created.

Type: EventHandler<Department>

DepartmentUpdated

Fires when a department has been edited.

Type: EventHandler<Department>

DepartmentDeleted

Fires when a department has been deleted.

Type: EventHandler<Department>

DivisionCreated

Fires when a division has been created.

Type: EventHandler<Division>

DivisionUpdated

Fires when a division has been edited.

Type: EventHandler<Division>

DivisionDeleted

Fires when a division has been deleted.

Type: EventHandler<Division>

PlayerJoinedDepartment

Fires when a player joins a department or has been added to one with the API.

Type: EventHandler<PlayerDepartmentChangeEventArgs>

PlayerLeftDepartment

Fires when a player leaves a department or has been removed from one with the API.

Type: EventHandler<PlayerDepartmentChangeEventArgs>