view CodeAnalysis/CustomFunctions.json @ 207:968dbd6982bb

renamed variables to highlight that they are Python dictionaries
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 12:38:31 +0200
parents 234681297600
children 315e1720a35f
line wrap: on
line source

[
  {
    "short_name" : "RegisterRestCallback",
    "implementation" : "RegisterRestCallback",
    "documentation" : {
      "description" : [ "Register a REST callback." ],
      "args" : {
        "pathRegularExpression" : "Regular expression for the URI. May contain groups.",
        "callback" : "The callback function to handle the REST call."
      }
    },
    "args" : [
      {
        "sdk_name" : "pathRegularExpression",
        "sdk_type" : "const char *"
      },
      {
        "sdk_name" : "callback",
        "sdk_type" : "Callable",
        "callable_type" : "RestCallback",
        "callable_protocol_args" : "output: RestOutput, url: str, method: HttpMethod, groups: dict, get: dict, headers: dict, body: bytes=None",
        "callable_protocol_return" : "None"
      }
    ],
    "return_sdk_type" : "void"
  },

  {
    "short_name" : "RegisterOnChangeCallback",
    "implementation" : "RegisterOnChangeCallback",
    "documentation" : {
      "description" : [ "Register a callback to monitor changes." ],
      "args" : {
        "callback" : "The callback function."
      }
    },
    "args" : [
      {
        "sdk_name" : "callback",
        "sdk_type" : "Callable",
        "callable_type" : "OnChangeCallback",
        "callable_protocol_args" : "change_type: ChangeType, resource_type: ResourceType, resource_id: str",
        "callable_protocol_return" : "None"
      }
    ],
    "return_sdk_type" : "void"
  },

  {
    "short_name" : "RegisterOnStoredInstanceCallback",
    "implementation" : "RegisterOnStoredInstanceCallback",
    "documentation" : {
      "description" : [ "Register a callback for received DICOM instances." ],
      "args" : {
        "callback" : "The callback function."
      }
    },
    "args" : [
      {
        "sdk_name" : "callback",
        "sdk_type" : "Callable",
        "callable_type" : "OnStoredInstanceCallback",
        "callable_protocol_args" : "instance: DicomInstance, instance_id: str",
        "callable_protocol_return" : "None"
      }
    ],
    "return_sdk_type" : "void"
  },

  {
    "comment" : "New in release 3.0",
    "short_name" : "RegisterIncomingHttpRequestFilter",
    "implementation" : "RegisterIncomingHttpRequestFilter",
    "documentation" : {
      "description" : [ "Callback to filter incoming HTTP requests received by Orthanc." ],
      "args" : {
        "callback" : "The callback function."
      }
    },
    "args" : [
      {
        "sdk_name" : "callback",
        "sdk_type" : "Callable",
        "callable_type" : "IncomingHttpRequestFilter",
        "callable_protocol_args" : "uri: str, method: HttpMethod, ip: str, headers: dict, get: dict",
        "callable_protocol_return" : "bool"
      }
    ],
    "return_sdk_type" : "void"
  },

  {
    "comment" : "New in release 3.2",
    "short_name" : "LookupDictionary",
    "implementation" : "LookupDictionary",
    "documentation" : {
      "description" : [ "Get information about the given DICOM tag." ],
      "args" : {
        "name" : "The name of the DICOM tag."
      },
      "return" : "Dictionary containing the requested information."
    },
    "args" : [
      {
        "sdk_name" : "name",
        "sdk_type" : "const char *"
      }
    ],
    "return_sdk_type" : "Dictionary"
  }
]