FlyMenu

public class FlyMenu

Service principal à utiliser pour récupérer les recettes, tags, et types

Propriétés principales :

  • shared : singleton de la classe, à utiliser pour tous les appels : Flymenu.shared.fetch…

Méthodes principales :

  • initialize : A appeler avant tout appel, à initialiser avec nom et password API
  • fetchRecipeTags : Récupération des tags des recettes (vegan, sans porc…)
  • fetchRecipeTypes : Récupération des types de recette (entrée, plat…)
  • fetchRecipes : Récupération des recettes à partir de critère de recherche

  • Singleton Usage : FlyMenu.shared.fetchRecipes(…

    Declaration

    Swift

    public static let shared: FlyMenu

  • Initialisateur du SDK, fonction à appeler avant toute utilisation du SDK

    Declaration

    Swift

    public func initialize(user: String, password: String) async -> Bool

    Parameters

    user

    user de l'API
    password

    password de l'utilisateur API

  • Retourne un type de recette (FlyMenuRecipeType) à partir de son id

    Declaration

    Swift

    public func getRecipeType(type_id: Int) -> FlyMenuRecipeType?

    Parameters

    type_id

    id du type

    Return Value

    FlyMenuRecipeType, nil si id introuvable

  • Retourne une catégorie de tag de recette (FlyMenuRecipeTagCategory) à partir de son id

    Declaration

    Swift

    public func getRecipeTagCategory(tag_category_id: Int) -> FlyMenuRecipeTagCategory?

    Parameters

    tag_category_id

    id de la catégorie

    Return Value

    FlyMenuRecipeTagCategory, null si id introuvable

  • Retourne un tag de recette (FlyMenuRecipeTag) à partir de son id

    Declaration

    Swift

    public func getRecipeTag(tag_id: Int) -> FlyMenuRecipeTag?

    Parameters

    tag_id

    id du tag

    Return Value

    FlyMenuRecipeTag, null si id introuvable

  • fetchRecipes(search:) Asynchronous

    Retourne une liste de recettes ([FlyMenuRecipe]) à partir de critères de recherche (FlyMenuRecipeSearch)

    Declaration

    Swift

    public func fetchRecipes(search: FlyMenuRecipeSearch) async -> FlyMenuRecipeResponse?

    Parameters

    search

    FlyMenuRecipeSearch, critères de recherche

    Return Value

    Résultat de recettes FlyMenuRecipeResponse

  • fetchRecipeTags() Asynchronous

    Retourne la liste des catégories de tags des recettes

    Declaration

    Swift

    public func fetchRecipeTags() async -> [FlyMenuRecipeTagCategory]
  • fetchRecipeTypes() Asynchronous

    Retourne la liste des types de recette

    Declaration

    Swift

    public func fetchRecipeTypes() async -> [FlyMenuRecipeType]