cups-pk-helper offer a set of PolicyKit authenticated methods to configure CUPS
server.

Homepage: http://www.vuntz.net/git/cups-pk-helper.git

Methods:

  FileGet ()

    <method name="FileGet">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="resource" direction="in"  type="s"/>
      <arg name="filename" direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Get a file from a CUPS server and stores it to a given file.

      resource : file to get
      filename : where to store the file
      error    : error string

  ------------------------------------------------------------------------------


  FilePut ()

    <method name="FilePut">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="resource" direction="in"  type="s"/>
      <arg name="filename" direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Put a file to a CUPS server.

      resource : destination of the file
      filename : source file
      error    : error string

  ------------------------------------------------------------------------------


  PrinterAdd ()

    <method name="PrinterAdd">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="uri"      direction="in"  type="s"/>
      <arg name="ppd"      direction="in"  type="s"/>
      <arg name="info"     direction="in"  type="s"/>
      <arg name="location" direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Add a new printer.

      name     : name of the new printer
      uri      : URI of the new printer
      ppd      : a PPD file to use with the new printer
      info     : a textual description of the new printer
      location : location of the new printer
      error    : error string

  ------------------------------------------------------------------------------


  PrinterAddWithPpdFile ()

    <method name="PrinterAddWithPpdFile">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="uri"      direction="in"  type="s"/>
      <arg name="ppd"      direction="in"  type="s"/>
      <arg name="info"     direction="in"  type="s"/>
      <arg name="location" direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Add a new printer.

      name     : name of the new printer
      uri      : URI of the new printer
      ppd      : a PPD file to use with the new printer
      info     : a textual description of the new printer
      location : location of the new printer
      error    : error string

  ------------------------------------------------------------------------------


  PrinterSetDevice ()

    <method name="PrinterSetDevice">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="device"   direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the device URI for a printer.

      name   : printer's name
      device : URI of the printer
      error  : error string

  ------------------------------------------------------------------------------


  PrinterSetInfo ()

    <method name="PrinterSetInfo">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="info"     direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set a textual description of a printer.

        name  : printer's name
        info  : a textual description of the printer
        error : error string

  ------------------------------------------------------------------------------


  PrinterSetLocation ()

    <method name="PrinterSetLocation">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="location" direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the location of a printer.

      name     : printer's name
      location : location of the printer
      error    : error string

  ------------------------------------------------------------------------------


  PrinterSetShared ()

    <method name="PrinterSetShared">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="shared"   direction="in"  type="b"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set whether a printer is shared with other people.

      name   : printer's name
      shared : if True, the printer will be shared
      error  : error string

  ------------------------------------------------------------------------------


  PrinterSetJobSheets ()

    <method name="PrinterSetJobSheets">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="start"    direction="in"  type="s"/>
      <arg name="end"      direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Specifies job sheets.

      name  : printer's name
      start : start sheet
      end   : end sheet
      error : error string

  ------------------------------------------------------------------------------


  PrinterSetErrorPolicy ()

    <method name="PrinterSetErrorPolicy">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="policy"   direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the printer's error policy.

      name   : printer's name
      policy : policy name
      error  : error string

  ------------------------------------------------------------------------------


  PrinterSetOpPolicy ()

    <method name="PrinterSetOpPolicy">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="policy"   direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the printer's operation policy.

      name   : printer's name
      policy : policy name
      error  : error string

  ------------------------------------------------------------------------------


  PrinterSetUsersAllowed ()

    <method name="PrinterSetUsersAllowed">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="users"    direction="in"  type="as"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the list of users allowed to use a printer.

      name  : printer's name
      users : the list of users
      error : error string

  ------------------------------------------------------------------------------


  PrinterSetUsersDenied ()

    <method name="PrinterSetUsersDenied">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="users"    direction="in"  type="as"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set the list of users denied the use of a printer.

      name  : printer's name
      users : the list of users
      error : error string

  ------------------------------------------------------------------------------


  PrinterAddOptionDefault ()

    <method name="PrinterAddOptionDefault">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="option"   direction="in"  type="s"/>
      <arg name="values"   direction="in"  type="as"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Add a network default option. Jobs submitted to the named queue will have
    the job option added

      name   : printer's name
      option : the network option to add
      values : a value of the added option
      error  : error string

  ------------------------------------------------------------------------------


  PrinterDeleteOptionDefault ()

    <method name="PrinterDeleteOptionDefault">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="option"   direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Remove a network default option.

      name   : printer's name
      option : the network option to remove
      error  : error string

  ------------------------------------------------------------------------------


  PrinterDelete ()

    <method name="PrinterDelete">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Delete a printer.

      name  : printer's name
      error : error string

  ------------------------------------------------------------------------------


  ClassAddPrinter ()

    <method name="ClassAddPrinter">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="printer"  direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Add a printer to a class.

      name    : class' name
      printer : printer to add
      error   : error string

  ------------------------------------------------------------------------------


  ClassDeletePrinter ()

    <method name="ClassDeletePrinter">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="printer"  direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Delete a printer from a class.

      name    : class' name
      printer : printer to delete
      error   : error string

  ------------------------------------------------------------------------------


  ClassDelete ()

    <method name="ClassDelete">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Delete a class.

      name  : class' name
      error : error string

  ------------------------------------------------------------------------------


  PrinterSetDefault ()

    <method name="PrinterSetDefault">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set default printer.

      name  : printer's name
      error : error string

  ------------------------------------------------------------------------------


  PrinterSetEnabled ()

    <method name="PrinterSetEnabled">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="enabled"  direction="in"  type="b"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Enable/disable a printer.

      name    : printer's name
      enabled : if True, the printer will be enabled
      error   : error string

  ------------------------------------------------------------------------------


  PrinterSetAcceptJobs ()

    <method name="PrinterSetAcceptJobs">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name"     direction="in"  type="s"/>
      <arg name="enabled"  direction="in"  type="b"/>
      <arg name="reason"   direction="in"  type="s"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set whether a printer accepts jobs.

      name    : printer's name
      enabled : if True, the printer will accept jobs
      reason  :
      error   : error string

  ------------------------------------------------------------------------------


  ServerGetSettings ()

    <method name="ServerGetSettings">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="error"    direction="out" type="s"/>
      <arg name="settings" direction="out" type="a{ss}"/>
    </method>

    Get server settings.

      error    : error string
      settings : server's settings

  ------------------------------------------------------------------------------


  ServerSetSettings ()

    <method name="ServerSetSettings">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="settings" direction="in"  type="a{ss}"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Set server settings.

      settings : new settings
      error    : error string

  ------------------------------------------------------------------------------


  JobCancel ()

    <method name="JobCancel">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="jobid"    direction="in"  type="i"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Cancel a job.

      jobid : id of a job to cancel
      error : error string

  ------------------------------------------------------------------------------


  JobRestart ()

    <method name="JobRestart">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="jobid"    direction="in"  type="i"/>
      <arg name="error"    direction="out" type="s"/>
    </method>

    Restart a job.

      jobid : id of job to restart
      error : error string

  ------------------------------------------------------------------------------


  JobSetHoldUntil ()

    <method name="JobSetHoldUntil">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="jobid"          direction="in"  type="i"/>
      <arg name="job_hold_until" direction="in"  type="s"/>
      <arg name="error"          direction="out" type="s"/>
    </method>

    Set job-hold-until property of given job.

      jobid          : id of a job
      job_hold_until : new value of job-hold-until property
      error          : error string