From eebeb26001e40c4a0012b4db77eb1e245106d93f Mon Sep 17 00:00:00 2001 From: Peter Pfeufer Date: Mon, 18 Dec 2023 00:59:36 +0100 Subject: [PATCH] [ADD] API docu --- docs/development/custom/framework/api.md | 30 ++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/development/custom/framework/api.md b/docs/development/custom/framework/api.md index ab539803..a832a361 100644 --- a/docs/development/custom/framework/api.md +++ b/docs/development/custom/framework/api.md @@ -4,8 +4,37 @@ ### get_main_character_from_user +This is to get the main character object (`EveCharacter`) of a user. + +Given we have a `User` object called `my_user` and we want to get the main character: + +```python +# Alliance Auth +from allianceauth.framework.api.user import get_main_character_from_user + +main_character = get_main_character_from_user(user=my_user) +``` + +Now, `main_character` is an `EveCharacter` object, or `None` if the user has no main +character or the user is `None`. + ### get_main_character_name_from_user +This is to get the name of the main character of a user. + +Given we have a `User` object called `my_user` and we want to get the main character name: + +```python +# Alliance Auth +from allianceauth.framework.api.user import get_main_character_name_from_user + +main_character = get_main_character_name_from_user(user=my_user) +``` + +Now, `main_character` is a `string` containing the user's main character name. +If the user has no main character, the username will be returned. If the user is `None`, +the sentinel username (see [get_sentinel_user](#get-sentinel-user)) will be returned. + ### get_sentinel_user This function is useful in models when using `User` model-objects as foreign keys. @@ -15,6 +44,7 @@ deleted. To keep the data, you can have Django map this to the sentinel user. Import: ```python +# Alliance Auth from allianceauth.framework.api.user import get_sentinel_user ```