gitea/src/2a6f99df-a327-4477-8079-f57.../README.md

2.1 KiB

██████╗  ██████╗ ██╗    ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║    ██║██╔════╝██╔══██╗
██████╔╝██║   ██║██║ █╗ ██║█████╗  ██████╔╝
██╔═══╝ ██║   ██║██║███╗██║██╔══╝  ██╔══██╗
██║     ╚██████╔╝╚███╔███╔╝███████╗██║  ██║
╚═╝      ╚═════╝  ╚══╝╚══╝ ╚══════╝╚═╝  ╚═╝

class PublicMembers (Details)

namespace: VDM\Joomla\Gitea\Organization extends: Api

@startuml
class PublicMembers  #Gold {
  + list(string $orgName, int $page = 1, ...) : ?array
  + check(string $org, string $username) : ?string
  + publicize(string $org, string $username) : ?string
  + conceal(string $org, string $username) : string
}

note right of PublicMembers::list
  List an organization's public members.

  since: 3.2.0
  return: ?array
  
  arguments:
    string $orgName
    int $page = 1
    int $limit = 10
end note

note right of PublicMembers::check
  Check if a user is a public member of an organization.

  since: 3.2.0
  return: ?string
end note

note right of PublicMembers::publicize
  Publicize a user's membership.

  since: 3.2.0
  return: ?string
end note

note right of PublicMembers::conceal
  Conceal a user's membership.

  since: 3.2.0
  return: string
end note
 
@enduml

     ██╗ ██████╗██████╗
     ██║██╔════╝██╔══██╗
     ██║██║     ██████╔╝
██   ██║██║     ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
 ╚════╝  ╚═════╝╚═════╝

Build with Joomla Component Builder