seitime-frappe/frappe/docs/current/api/frappe.sessions.html

<!-- title: frappe.sessions --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
	Version 6.6.5</a>


	<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/sessions.py"
		target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>





	
        
	<h3 style="font-weight: normal;">Class <b>Session</b></h3>
    
    <div class="docs-attr-desc"><p></p>
</div>
    <div style="padding-left: 30px;">
        
        
    
    
	<p class="docs-attr-name">
        <a name="__init__" href="#__init__" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>__init__</b>
        <i class="text-muted">(self, user, resume=False, full_name=None, user_type=None)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="delete_session" href="#delete_session" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>delete_session</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="get_expiry_in_seconds" href="#get_expiry_in_seconds" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>get_expiry_in_seconds</b>
        <i class="text-muted">(self, expiry)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="get_session_data" href="#get_session_data" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>get_session_data</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="get_session_data_from_cache" href="#get_session_data_from_cache" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>get_session_data_from_cache</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="get_session_data_from_db" href="#get_session_data_from_db" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>get_session_data_from_db</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="get_session_record" href="#get_session_record" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>get_session_record</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p>get session record, or return the standard Guest Record</p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="insert_session_record" href="#insert_session_record" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>insert_session_record</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="resume" href="#resume" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>resume</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p>non-login request: load a session</p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="start" href="#start" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>start</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p>start a new session</p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="start_as_guest" href="#start_as_guest" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>start_as_guest</b>
        <i class="text-muted">(self)</i>
    </p>
	<div class="docs-attr-desc"><p>all guests share the same 'Guest' session</p>
</div>
	<br>

        
        
    
    
	<p class="docs-attr-name">
        <a name="update" href="#update" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		<b>update</b>
        <i class="text-muted">(self, force=False)</i>
    </p>
	<div class="docs-attr-desc"><p>extend session expiry</p>
</div>
	<br>

        
    </div>
    <hr>

	

	
        
    
    <p><span class="label label-info">Public API</span>
        <br><code>/api/method/frappe.sessions.clear</code>
    </p>
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear" href="#frappe.sessions.clear" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear</b>
        <i class="text-muted">(user=None)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear_all_sessions" href="#frappe.sessions.clear_all_sessions" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear_all_sessions</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>This effectively logs out all users</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear_cache" href="#frappe.sessions.clear_cache" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear_cache</b>
        <i class="text-muted">(user=None)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear_expired_sessions" href="#frappe.sessions.clear_expired_sessions" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear_expired_sessions</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>This function is meant to be called from scheduler</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear_global_cache" href="#frappe.sessions.clear_global_cache" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear_global_cache</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.clear_sessions" href="#frappe.sessions.clear_sessions" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>clear_sessions</b>
        <i class="text-muted">(user=None, keep_current=False)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.delete_session" href="#frappe.sessions.delete_session" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>delete_session</b>
        <i class="text-muted">(sid=None, user=None)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.generate_csrf_token" href="#frappe.sessions.generate_csrf_token" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>generate_csrf_token</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.get" href="#frappe.sessions.get" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>get</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p>get session boot info</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.get_csrf_token" href="#frappe.sessions.get_csrf_token" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>get_csrf_token</b>
        <i class="text-muted">()</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.get_expiry_period" href="#frappe.sessions.get_expiry_period" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>get_expiry_period</b>
        <i class="text-muted">(device=desktop)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.get_geo_from_ip" href="#frappe.sessions.get_geo_from_ip" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>get_geo_from_ip</b>
        <i class="text-muted">(ip_addr)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.sessions.get_geo_ip_country" href="#frappe.sessions.get_geo_ip_country" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.sessions.<b>get_geo_ip_country</b>
        <i class="text-muted">(ip_addr)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	



<!-- autodoc -->